Package velox.api.layer1
Interface Layer1ApiAdminListener
- All Known Subinterfaces:
Layer1ApiAdapter
,Layer1ApiAdminAdapter
,Layer1ApiListener
- All Known Implementing Classes:
Layer1ApiDepthFreezer
,Layer1ApiInjectorRelay
,Layer1ApiRelay
,Layer1ApiStrategiesEchoMessagesLayer
,Layer1ApiUpstreamRelay
public interface Layer1ApiAdminListener
Listens to general events, such as login results, disconnections, warnings,
etc.
-
Method Summary
Modifier and Type Method Description void
onConnectionLost(DisconnectionReason reason, java.lang.String message)
Connection to server lostvoid
onConnectionRestored()
Connection to server restoredvoid
onLoginFailed(LoginFailedReason reason, java.lang.String message)
Failed to login with specified credentialsvoid
onLoginSuccessful()
Successful login.void
onSystemTextMessage(java.lang.String message, SystemTextMessageType messageType)
Some message from the system.void
onUserMessage(java.lang.Object data)
Allows incorporating arbitrary functionality into protocol
-
Method Details
-
onLoginFailed
Failed to login with specified credentials- Parameters:
reason
- reason codemessage
- test message associated with login fail (may be null)
-
onLoginSuccessful
void onLoginSuccessful()Successful login. -
onConnectionLost
Connection to server lost- Parameters:
reason
- reason codemessage
- test message associated with login disconnection (may be null)
-
onConnectionRestored
void onConnectionRestored()Connection to server restored -
onSystemTextMessage
Some message from the system. Usually you want to show it to user in some way- Parameters:
message
- message itselfmessageType
- message type
-
onUserMessage
void onUserMessage(java.lang.Object data)Allows incorporating arbitrary functionality into protocol- Parameters:
data
- Message content
-