net.roboconf.messaging.client

Interface IClient

All Known Subinterfaces:

IAgentClient, IDmClient

All Known Implementing Classes:

DismissClientAgent, DismissClientDm, RabbitMqClientAgent, RabbitMqClientDm, ReconfigurableClient, ReconfigurableClientAgent, ReconfigurableClientDm, TestClientAgent, TestClientDm

public interface IClient

Author:

Vincent Zurczak - Linagora

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IClient.ListenerCommand Start or stop listening to events.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection() Closes the connection with the message server.
boolean	isConnected()
void	listenToTheDm(IClient.ListenerCommand command) Configures the listener for messages from the DM.
void	openConnection() Opens a connection with the message server.
void	sendMessageToTheDm(Message message) Sends a message to the DM.
void	setMessageQueue(LinkedBlockingQueue<Message> messageQueue) Sets the message queue where the client can store the messages to process.
void	setParameters(String messageServerIp, String messageServerUsername, String messageServerPassword) Sets the connection parameters.

Method Detail

setParameters

void setParameters(String messageServerIp,
                 String messageServerUsername,
                 String messageServerPassword)

Sets the connection parameters.

Parameters:

messageServerIp - the IP address of the messaging server

messageServerUsername - the user name to connect to the server

messageServerPassword - the password to connect to the server

setMessageQueue

void setMessageQueue(LinkedBlockingQueue<Message> messageQueue)

Sets the message queue where the client can store the messages to process.

Parameters:

messageQueue - the message queue

isConnected

boolean isConnected()

Returns:

true if the client is connected, false otherwise

openConnection

void openConnection()
                    throws IOException

Opens a connection with the message server.

Throws:

IOException

closeConnection

void closeConnection()
                     throws IOException

Closes the connection with the message server.

There is no need to check isConnected() before invoking this method.

Throws:

IOException

sendMessageToTheDm

void sendMessageToTheDm(Message message)
                        throws IOException

Sends a message to the DM.

Parameters:

message - the message to send

Throws:

IOException - if something went wrong

listenToTheDm

void listenToTheDm(IClient.ListenerCommand command)
                   throws IOException

Configures the listener for messages from the DM.

Parameters:

command - IClient.ListenerCommand.START to stop listening, IClient.ListenerCommand.STOP to stop listening

Throws:

IOException - if something went wrong