velox.api.layer1

Interface Layer1ApiAdminListener

All Known Subinterfaces:

Layer1ApiAdapter, Layer1ApiAdminAdapter, Layer1ApiListener

All Known Implementing Classes:

Layer1ApiInjectorRelay, Layer1ApiRelay, Layer1ApiStrategiesEchoMessagesLayer, Layer1ApiUpstreamRelay

public interface Layer1ApiAdminListener

Listens to general events, such as login results, disconnections, warnings, etc.

Method Summary

Modifier and Type	Method and Description
void	onConnectionLost(DisconnectionReason reason, java.lang.String message) Connection to server lost
void	onConnectionRestored() Connection to server restored
void	onLoginFailed(LoginFailedReason reason, java.lang.String message) Failed to login with specified credentials
void	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 Detail

onLoginFailed

void onLoginFailed(LoginFailedReason reason,
                   java.lang.String message)

Failed to login with specified credentials

Parameters:

reason - reason code

message - test message associated with login fail (may be null)

onLoginSuccessful

void onLoginSuccessful()

Successful login.

onConnectionLost

void onConnectionLost(DisconnectionReason reason,
                      java.lang.String message)

Connection to server lost

Parameters:

reason - reason code

message - test message associated with login disconnection (may be null)

onConnectionRestored

void onConnectionRestored()

Connection to server restored

onSystemTextMessage

void onSystemTextMessage(java.lang.String message,
                         SystemTextMessageType messageType)

Some message from the system. Usually you want to show it to user in some way

Parameters:

message - message itself

messageType - message type

onUserMessage

void onUserMessage(java.lang.Object data)

Allows incorporating arbitrary functionality into protocol

Parameters:

data - Message content