Package com.iizix.server

Interface IEndPoint

All Known Implementing Classes:
AbstractEndPoint, ClientEndPoint, FailedReconnectClientEndPoint, LoadBalancerEndPoint, RemoteBuilderEndPoint, ServerSession, VirtualizedMonitorEndPoint, VSViewerEndPoint
public interface IEndPoint
Interface for Server End Points.
Author:
Christopher Mindus

  • Field Details

    • STORAGE_NAME

      static final String STORAGE_NAME
      Local storage name in SessionInfo.

    • DEFAULT_HEARTBEAT_INTERVAL

      static final long DEFAULT_HEARTBEAT_INTERVAL
      Default heart-beat interval in milliseconds (20 seconds).
      See Also:

  • Method Details

    • getSessionInstance

      static IEndPoint getSessionInstance()
      Gets the runtime application instance for the current thread in a client session.
      Returns:
      The RuntimeApp instance when called from a thread of the client session, null otherwise.

    • getEndPointType

      IEndPoint.Type getEndPointType()
      Gets the end point type.
      Returns:
      The endpoint type.

    • getEndPointName

      String getEndPointName()
      Gets the end point name.
      Returns:
      A short descriptive end-point type name.

    • getServerSessionID

      long getServerSessionID()
      Gets the Server Session ID.
      Returns:
      The session ID.

    • getSessionInfo

      SessionInfo getSessionInfo()
      Gets the SessionInfo for this end point.
      Returns:
      The SessionInfo instance.

    • getServer

      ServerShell getServer()
      Gets the server instance.
      Returns:
      The server instance.

    • getWebSocketCommListener

      IServerWebSocketCommListener getWebSocketCommListener(IWebSocketComm comm)
      Gets the WebSocketCommListener for the end point.
      Parameters:
      comm - The WebSocket communication instance.
      Returns:
      The WebSocket listener.

    • dispose

      boolean dispose()
      Disposes of the end point.
      Returns:
      true if disposed, false if already disposed of.