|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface IConnection
The connection object. Each connection has an associated client and scope. Connections may be persistent, polling, or transient. The aim of this interface is to provide basic connection methods shared between different types of connections Future subclasses: RTMPConnection, RemotingConnection, AJAXConnection, HttpConnection, etc
| Nested Class Summary | |
|---|---|
static class |
IConnection.Encoding
AMF version types, either AMF0 or AMF3. |
| Field Summary | |
|---|---|
static String |
PERSISTENT
Persistent connection type, eg RTMP. |
static String |
POLLING
Polling connection type, eg RTMPT. |
static String |
TRANSIENT
Transient connection type, eg Remoting, HTTP, etc. |
| Method Summary | |
|---|---|
void |
close()
Close this connection. |
boolean |
connect(IScope scope)
Try to connect to the scope. |
boolean |
connect(IScope scope,
Object[] params)
Try to connect to the scope with a list of connection parameters. |
Iterator<IBasicScope> |
getBasicScopes()
Get the basic scopes this connection has subscribed. |
IClient |
getClient()
Get the client object associated with this connection. |
long |
getClientBytesRead()
Return number of written bytes the client reports to have received. |
Map<String,Object> |
getConnectParams()
Return the parameters that were given in the call to "connect". |
long |
getDroppedMessages()
Total number of messages that have been dropped. |
IConnection.Encoding |
getEncoding()
Get the object encoding (AMF version) for this connection. |
String |
getHost()
Get the hostname that the client is connected to. |
int |
getLastPingTime()
Return roundtrip time of last ping command. |
String |
getPath()
Get the path for this connection. |
long |
getPendingMessages()
Total number of messages that are pending to be sent to the connection. |
long |
getReadBytes()
Total number of bytes read from the connection. |
long |
getReadMessages()
Total number of messages read from the connection. |
String |
getRemoteAddress()
Get the IP address the client is connected from. |
List<String> |
getRemoteAddresses()
Get the IP addresses the client is connected from. |
int |
getRemotePort()
Get the port the client is connected from. |
IScope |
getScope()
Get the scope this is connected to. |
String |
getSessionId()
Get the session id, this may be null. |
String |
getType()
Get the connection type. |
long |
getWrittenBytes()
Total number of bytes written to the connection. |
long |
getWrittenMessages()
Total number of messages written to the connection. |
void |
initialize(IClient client)
Initialize the connection. |
boolean |
isConnected()
Is the client connected to the scope. |
void |
ping()
Start measuring the roundtrip time for a packet on the connection. |
| Methods inherited from interface org.red5.server.api.ICastingAttributeStore |
|---|
getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute |
| Methods inherited from interface org.red5.server.api.IAttributeStore |
|---|
getAttribute, getAttribute, getAttributeNames, getAttributes, hasAttribute, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes |
| Methods inherited from interface org.red5.server.api.event.IEventDispatcher |
|---|
dispatchEvent |
| Methods inherited from interface org.red5.server.api.event.IEventHandler |
|---|
handleEvent |
| Methods inherited from interface org.red5.server.api.event.IEventListener |
|---|
notifyEvent |
| Field Detail |
|---|
static final String PERSISTENT
static final String POLLING
static final String TRANSIENT
| Method Detail |
|---|
String getType()
getType in interface ConnectionMBeanIConnection.Encoding getEncoding()
void initialize(IClient client)
initialize in interface ConnectionMBeanclient - Client object associated with connectionboolean connect(IScope scope)
connect in interface ConnectionMBeanscope - Scope object
true on success, false otherwise
boolean connect(IScope scope,
Object[] params)
connect in interface ConnectionMBeanparams - Connections parametersscope - Scope object
true on success, false otherwiseboolean isConnected()
true for persistent and polling connections, false for transient.
isConnected in interface ConnectionMBeantrue if the connection is persistent or polling,
otherwise falsevoid close()
close in interface ConnectionMBeanMap<String,Object> getConnectParams()
getConnectParams in interface ConnectionMBeanIClient getClient()
getClient in interface ConnectionMBeanString getHost()
getHost in interface ConnectionMBeanString getRemoteAddress()
getRemoteAddress in interface ConnectionMBeanList<String> getRemoteAddresses()
getRemoteAddresses in interface ConnectionMBeanint getRemotePort()
getRemotePort in interface ConnectionMBeanString getPath()
getPath in interface ConnectionMBeanString getSessionId()
null.
getSessionId in interface ConnectionMBeanlong getReadBytes()
getReadBytes in interface ConnectionMBeanlong getWrittenBytes()
getWrittenBytes in interface ConnectionMBeanlong getReadMessages()
getReadMessages in interface ConnectionMBeanlong getWrittenMessages()
getWrittenMessages in interface ConnectionMBeanlong getDroppedMessages()
getDroppedMessages in interface ConnectionMBeanlong getPendingMessages()
getPendingMessages in interface ConnectionMBeanlong getClientBytesRead()
BytesReadvoid ping()
ping in interface ConnectionMBeanint getLastPingTime()
getLastPingTime in interface ConnectionMBeanIScope getScope()
getScope in interface ConnectionMBeanIterator<IBasicScope> getBasicScopes()
getBasicScopes in interface ConnectionMBean
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||