Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StompServerConnection

Class representing a connection between a STOMP client a the server. It keeps a references on the client socket, so let write to this socket.

Hierarchy

  • StompServerConnection

Index

Methods

Methods

close

  • close(): void

  • Closes the connection with the client.

    Returns void

configureHeartbeat

  • Configures the heartbeat.

    Parameters

    Returns void

handler

onServerActivity

  • onServerActivity(): void

  • Notifies the connection about server activity (the server has sent a frame). This method is used to handle the heartbeat.

    Returns void

ping

  • ping(): void

  • Sends a PING frame to the client. A PING frame is a frame containing only EOL.

    Returns void

server

  • Returns StompServer

session

  • session(): string

  • Returns string

sslSession

  • sslSession(): any

  • Returns any

write

  • Writes the given frame to the socket.

    Parameters

    Returns StompServerConnection

  • Writes the given buffer to the socket. This is a low level API that should be used carefully.

    Parameters

    • buffer: Buffer

    Returns StompServerConnection

Generated using TypeDoc