org.yamcs.api.artemis

Interface ConnectionListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

ArtemisEventProducer

public interface ConnectionListener
extends EventListener

A connection listener interface for clients connecting to a yamcs server.

Method Summary

Modifier and Type	Method and Description
void	connected(String url) Called after a successful connection to the yamcs server has been established.
void	connecting(String url) Called right before the initial connection to yamcs is being made.
void	connectionFailed(String url, YamcsException exception) Called when the initial connection to the yamcs server has failed, e.g.
void	disconnected() Called when the connection to the yamcs server is closed.
void	log(String message) Used to log messages.

Method Detail

connecting

void connecting(String url)

Called right before the initial connection to yamcs is being made.

Parameters:

url - the url of the yamcs server

connected

void connected(String url)

Called after a successful connection to the yamcs server has been established.

Note: when using a re-connecting YamcsConnector, this method is also called after a successful re-connection attempt.

Parameters:

url - the url of the yamcs server

connectionFailed

void connectionFailed(String url,
                      YamcsException exception)

Called when the initial connection to the yamcs server has failed, e.g. the maximum number of retry attempts has exceeded.

Parameters:

url - the url of the yamcs server

exception - Optional cause of the connection failure, may be null.

disconnected

void disconnected()

Called when the connection to the yamcs server is closed.

log

void log(String message)

Used to log messages.

Parameters:

message - the messages to be logged