Package com.corundumstudio.socketio

Interface SocketIOClient

All Superinterfaces:
ClientOperations, Store
All Known Implementing Classes:
NamespaceClient
public interface SocketIOClient extends ClientOperations, Store
Fully thread-safe.

  • Method Details

    • getHandshakeData

      HandshakeData getHandshakeData()
      Handshake data used during client connection
      Returns:
      HandshakeData

    • getTransport

      Transport getTransport()
      Current client transport protocol
      Returns:
      transport protocol

    • getEngineIOVersion

      EngineIOVersion getEngineIOVersion()
      Engine IO Protocol version
      Returns:

    • isWritable

      boolean isWritable()
      Returns true if and only if the I/O thread will perform the requested write operation immediately. Any write requests made when this method returns false are queued until the I/O thread is ready to process the queued write requests.
      Returns:

    • sendEvent

      void sendEvent(String name, AckCallback<?> ackCallback, Object... data)
      Send event with ack callback
      Parameters:
      name - - event name
      ackCallback - - ack callback
      data - - event data

    • send

      void send(Packet packet, AckCallback<?> ackCallback)
      Send packet with ack callback
      Parameters:
      packet - - packet to send
      ackCallback - - ack callback

    • getNamespace

      SocketIONamespace getNamespace()
      Client namespace
      Returns:
      - namespace

    • getSessionId

      UUID getSessionId()
      Client session id, uses UUID object
      Returns:
      - session id

    • getRemoteAddress

      SocketAddress getRemoteAddress()
      Get client remote address
      Returns:
      remote address

    • isChannelOpen

      boolean isChannelOpen()
      Check is underlying channel open
      Returns:
      true if channel open, otherwise false

    • joinRoom

      void joinRoom(String room)
      Join client to room
      Parameters:
      room - - name of room

    • joinRooms

      void joinRooms(Set<String> rooms)
      Join client to rooms
      Parameters:
      rooms - - names of rooms

    • leaveRoom

      void leaveRoom(String room)
      Leave client from room
      Parameters:
      room - - name of room

    • leaveRooms

      void leaveRooms(Set<String> rooms)
      Leave client from rooms
      Parameters:
      rooms - - names of rooms

    • getAllRooms

      Set<String> getAllRooms()
      Get all rooms a client is joined in.
      Returns:
      name of rooms

    • getCurrentRoomSize

      int getCurrentRoomSize(String room)
      Get current room Size (contain in cluster)
      Parameters:
      room - - name of room
      Returns:
      int