Class ClientEndPoint
java.lang.Object
com.iizix.server.client.ClientEndPoint
- All Implemented Interfaces:
IEndPoint
Nested Class Summary
Nested classes/interfaces inherited from interface IEndPoint
IEndPoint.TypeField Summary
Fields inherited from interface IEndPoint
DEFAULT_HEARTBEAT_INTERVAL, STORAGE_NAMEMethod Summary
Modifier and TypeMethodDescriptionvoidcloseForServerExit(String text) Closes the client for a server exit: the close codeGCloseCodes.CC_SERVER_RESTARTwith the text, then the session is disposed of (CC-SERVER-RESTART-UPDATE-V5).booleandispose()Disposes of the end point.Gets the end point name.Gets the end point type.Gets the port configuration of the connector this end point's connection arrived on (CC-FIX-PORTS-OWN-PORT-CONFIRM): thePortConfigthe web server built the connector with, the same instance the connector'sIPortController.getConfiguration()answers.Gets the server instance.longGets the Server Session ID.Gets the SessionInfo for this end point.Returns the session statistics.Gets the client transaction processor.Gets the WebSocketCommListener for the end point.booleanChecks if the client end point is disposed of.booleanChecks if the client is iiziRun on Cordova, which cannot reload a page and restarts the app instead (CC-SERVER-RESTART-UPDATE-V5).
Method Details
getStatistics
Returns the session statistics.getWebSocketCommListener
Gets the WebSocketCommListener for the end point.- Specified by:
getWebSocketCommListenerin interfaceIEndPoint- Parameters:
comm- The WebSocket communication instance.- Returns:
- The WebSocket listener.
getTransactionProcessor
Gets the client transaction processor.getPortConfig
Gets the port configuration of the connector this end point's connection arrived on (CC-FIX-PORTS-OWN-PORT-CONFIRM): thePortConfigthe web server built the connector with, the same instance the connector'sIPortController.getConfiguration()answers.- Returns:
- The port configuration, or null when the connection carries none (a connector built without one).
getServerSessionID
public long getServerSessionID()Gets the Server Session ID.- Specified by:
getServerSessionIDin interfaceIEndPoint- Returns:
- The session ID.
getServer
Gets the server instance.getEndPointType
Gets the end point type.- Specified by:
getEndPointTypein interfaceIEndPoint- Returns:
- The endpoint type.
getEndPointName
Gets the end point name.- Specified by:
getEndPointNamein interfaceIEndPoint- Returns:
- A short descriptive end-point type name.
getSessionInfo
Gets the SessionInfo for this end point.- Specified by:
getSessionInfoin interfaceIEndPoint- Returns:
- The SessionInfo instance.
dispose
isIiziRun
public boolean isIiziRun()Checks if the client is iiziRun on Cordova, which cannot reload a page and restarts the app instead (CC-SERVER-RESTART-UPDATE-V5).- Returns:
- true when the client environment says iiziRun is present, false for a Browser or before the environment is known.
closeForServerExit
Closes the client for a server exit: the close codeGCloseCodes.CC_SERVER_RESTARTwith the text, then the session is disposed of (CC-SERVER-RESTART-UPDATE-V5).- Parameters:
text- The text the client is told, seeServerExitNotice.
isDisposed
public boolean isDisposed()Checks if the client end point is disposed of.