public interface ReservedSessionMessagesHandler extends SshdEventListener
SSH_MSG_IGNORE
and SSH_MSG_DEBUG
messages that are received
by a session, as well as proprietary and/or extension messages.Modifier and Type | Method and Description |
---|---|
default void |
handleDebugMessage(Session session,
Buffer buffer)
Invoked when an
SSH_MSG_DEBUG packet is received |
default void |
handleIgnoreMessage(Session session,
Buffer buffer)
Invoked when an
SSH_MSG_IGNORE packet is received |
default boolean |
handleUnimplementedMessage(Session session,
int cmd,
Buffer buffer)
Invoked when a packet with an un-implemented message is received - including
SSH_MSG_UNIMPLEMENTED itself |
default boolean |
sendReservedHeartbeat(ConnectionService service)
Invoked if the user configured usage of a proprietary heartbeat mechanism.
|
validateListener
default void handleIgnoreMessage(Session session, Buffer buffer) throws Exception
SSH_MSG_IGNORE
packet is receivedsession
- The Session
through which the message was receivedbuffer
- The Buffer
containing the dataException
- If failed to handle the messagedefault void handleDebugMessage(Session session, Buffer buffer) throws Exception
SSH_MSG_DEBUG
packet is receivedsession
- The Session
through which the message was receivedbuffer
- The Buffer
containing the dataException
- If failed to handle the messagedefault boolean handleUnimplementedMessage(Session session, int cmd, Buffer buffer) throws Exception
SSH_MSG_UNIMPLEMENTED
itselfsession
- The Session
through which the message was receivedcmd
- The received (un-implemented) commandbuffer
- The Buffer
containing the data - positioned just beyond the commandtrue
if message handled internally, false
if should return a
SSH_MSG_UNIMPLEMENTED
reply (default behavior)Exception
- If failed to handle the messagedefault boolean sendReservedHeartbeat(ConnectionService service) throws Exception
UnsupportedOperationException
so users who configure a proprietary heartbeat mechanism option must
provide an implementation for this method.service
- The ConnectionService
through which the heartbeat is being executed.true
whether heartbeat actually sent - Note: used mainly for debugging purposes.Exception
- If failed to send the heartbeat - Note: causes associated session termination.Copyright © 2008–2022 The Apache Software Foundation. All rights reserved.