org.eclipse.keyple.distributed.spi

Interface AsyncEndpointServer

public interface AsyncEndpointServer

SPI of the server endpoint using an asynchronous network protocol.

You must provide an implementation of this interface if you plan to use a full duplex communication protocol, such as Web Sockets for example.

Following the receive of a message from the client, the endpoint must :

• Associate the session with the the accessible sessionId value using the method MessageDto.getSessionId() on the received message in order to be able to retrieve the session later.
• Retrieve the AsyncNodeServer node using one of the following server utility methods, depending on your use case :
  • RemotePluginServerUtils.getAsyncNode()
  • LocalServiceServerUtils.getAsyncNode()
  • PoolLocalServiceServerUtils.getAsyncNode()
• Invoke the method AsyncNodeServer.onMessage(MessageDto) on the node.
• Invoke the method AsyncNodeServer.onClose(String) on the node after the session closing.

This endpoint interacts locally with a AsyncNodeServer node and remotely with a AsyncEndpointClient endpoint.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	sendMessage(MessageDto msg) Is invoked by the AsyncNodeServer node to send a MessageDto to the client.

Method Detail

sendMessage

void sendMessage(MessageDto msg)

Is invoked by the AsyncNodeServer node to send a MessageDto to the client.
You have to :

• Find the opened session using the accessible sessionId value using the method MessageDto.getSessionId() on the provided message to send.
• Serialize and send the MessageDto to the client.

Parameters:

msg - The message to send.

Since:

1.0