ch.awae.netcode

Interface NetcodeClient

public interface NetcodeClient

The client instance for the Netcode system. The client can receive messages synchronously and asynchronously. In any case the messages are read from the network asynchronously. If a MessageHandler is defined it gets invoked. If no such handler is specified the messages enter the message queue for synchronous reception using receive() or tryReceive(). The client can be switched between synchronous and asynchronous operation at any time. When switching from synchronous to asynchronous mode all the messages from the synchronous message queue are pushed into the message handler. During this phase it is possible that messages arrive out of order or multiple concurrent invocations of the handler exit. It is therefore recommended to avoid frequent mode switching. Threads blocked in receive() during the transition to asynchronous operation remain blocked indefinitely. Channel events can only be processed asynchronously. For this a ChannelEventHandler must be specified.

Since:

netcode 0.1.0

Author:

Andreas Wälchli

See Also:

NetcodeClientFactory

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.
Message	receive() Receive the next message synchronously and wait if no message is ready.
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	setEventHandler(ChannelEventHandler handler)
void	setMessageHandler(MessageHandler handler)
Message	tryReceive() Receive the next message synchronously if it exists.

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)

Send the given object to all members of the channel

sendPrivately

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

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.

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)

setEventHandler

void setEventHandler(ChannelEventHandler handler)

receive

Message receive()
         throws java.lang.InterruptedException

Receive the next message synchronously and wait if no message is ready. Note: if this method is called while a MessageHandler is present the call will block indefinitely.

Throws:

java.lang.InterruptedException

tryReceive

Message tryReceive()

Receive the next message synchronously if it exists. Otherwise returns null.