Package io.vertx.ext.stomp
Interface StompServerConnection
-
public interface StompServerConnectionClass representing a connection between a STOMP client a the server. It keeps a references on the client socket, so let write to this socket.- Author:
- Clement Escoffier
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()Closes the connection with the client.voidconfigureHeartbeat(long ping, long pong, Handler<StompServerConnection> pingHandler)Configures the heartbeat.StompServerHandlerhandler()voidonServerActivity()Notifies the connection about server activity (the server has sent a frame).voidping()Sends a `PING` frame to the client.StompServerserver()Stringsession()SSLSessionsslSession()StompServerConnectionwrite(Buffer buffer)Writes the given buffer to the socket.StompServerConnectionwrite(Frame frame)Writes the given frame to the socket.
-
-
-
Method Detail
-
write
StompServerConnection write(Frame frame)
Writes the given frame to the socket.- Parameters:
frame- the frame, must not benull.- Returns:
- the current
StompServerConnection
-
write
StompServerConnection write(Buffer buffer)
Writes the given buffer to the socket. This is a low level API that should be used carefully.- Parameters:
buffer- the buffer- Returns:
- the current
StompServerConnection
-
server
StompServer server()
- Returns:
- the STOMP server serving this connection.
-
sslSession
SSLSession sslSession()
- Returns:
- SSLSession associated with the underlying socket. Returns null if connection is not SSL.
-
handler
StompServerHandler handler()
- Returns:
- the STOMP server handler dealing with this connection
-
session
String session()
- Returns:
- the STOMP session id computed when the client has established the connection to the server
-
close
void close()
Closes the connection with the client.
-
ping
void ping()
Sends a `PING` frame to the client. A `PING` frame is a frame containing onlyEOL.
-
onServerActivity
void onServerActivity()
Notifies the connection about server activity (the server has sent a frame). This method is used to handle the heartbeat.
-
configureHeartbeat
void configureHeartbeat(long ping, long pong, Handler<StompServerConnection> pingHandler)Configures the heartbeat.- Parameters:
ping- ping timepong- pong timepingHandler- the ping handler
-
-