ch.awae.netcode

Interface NetcodeClient

public interface NetcodeClient

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnect and terminate the client.
ChannelConfiguration	getChannelConfiguration() Get the configuration of the connected channel.
java.lang.String	getUserId() Get the userId of this client.
java.lang.String[]	getUsers() Get a list of all members of the channel.
void	send(java.io.Serializable payload) Send the given object to all members of the channel
void	sendPrivately(java.lang.String userId, java.io.Serializable payload) Send the given object to the member of the channel with the given userId.
void	setMessageHandler(MessageHandler handler) Replace the message handler.

Method Detail

disconnect

void disconnect()
         throws java.io.IOException

Disconnect and terminate the client. After this method returns this instance may no longer be used.

Throws:

java.io.IOException

send

void send(java.io.Serializable payload)
   throws java.io.IOException

Send the given object to all members of the channel

Throws:

java.io.IOException

sendPrivately

void sendPrivately(java.lang.String userId,
                   java.io.Serializable payload)
            throws java.io.IOException

Send the given object to the member of the channel with the given userId. Only the specified user will (if he exists) receive the message. It will not be transmitted to any other clients.

Throws:

java.io.IOException

getUserId

java.lang.String getUserId()

Get the userId of this client.

getChannelConfiguration

ChannelConfiguration getChannelConfiguration()

Get the configuration of the connected channel.

getUsers

java.lang.String[] getUsers()

Get a list of all members of the channel. This list is automatically kept up to date.

setMessageHandler

void setMessageHandler(MessageHandler handler)

Replace the message handler. If no message handler has been set before the new handler will receive the full backlog of all previous messages.

Parameters:

handler -

Throws:

java.lang.NullPointerException - handler is null