akka.io

Class UdpConnectedMessage

java.lang.Object

akka.io.UdpConnectedMessage

public class UdpConnectedMessage
extends java.lang.Object

Java API: factory methods for the message types used when communicating with the UdpConnected service.

Constructor Summary

Constructors

Constructor and Description
UdpConnectedMessage()

Method Summary

Modifier and Type	Method and Description
static UdpConnected.Command	connect(ActorRef handler, java.net.InetSocketAddress remoteAddress) Connect without specifying the localAddress or options.
static UdpConnected.Command	connect(ActorRef handler, java.net.InetSocketAddress remoteAddress, java.net.InetSocketAddress localAddress, java.lang.Iterable<Inet.SocketOption> options) Send this message to the UdpExt.manager() in order to bind to a local port (optionally with the chosen localAddress) and create a UDP socket which is restricted to sending to and receiving from the given remoteAddress.
static UdpConnected.Command	connect(ActorRef handler, java.net.InetSocketAddress remoteAddress, java.lang.Iterable<Inet.SocketOption> options) Connect without specifying the localAddress.
static UdpConnected.Command	disconnect() Send this message to a connection actor (which had previously sent the UdpConnected.Connected message) in order to close the socket.
static UdpConnected.NoAck	noAck() Default UdpConnected.NoAck instance which is used when no acknowledgment information is explicitly provided.
static UdpConnected.NoAck	noAck(java.lang.Object token) Each UdpConnected.Send can optionally request a positive acknowledgment to be sent to the commanding actor.
static UdpConnected.Command	resumeReading() This message must be sent to the listener actor to re-enable reading from the socket after a UdpConnected.SuspendReading command.
static UdpConnected.Command	send(ByteString data) Send without requesting acknowledgment.
static UdpConnected.Command	send(ByteString data, java.lang.Object ack) This message is understood by the connection actors to send data to their designated destination.
static UdpConnected.Command	suspendReading() Send this message to a listener actor (which sent a Udp.Bound message) to have it stop reading datagrams from the network.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UdpConnectedMessage

public UdpConnectedMessage()

Method Detail

connect

public static UdpConnected.Command connect(ActorRef handler,
                                           java.net.InetSocketAddress remoteAddress,
                                           java.net.InetSocketAddress localAddress,
                                           java.lang.Iterable<Inet.SocketOption> options)

Send this message to the UdpExt.manager() in order to bind to a local port (optionally with the chosen localAddress) and create a UDP socket which is restricted to sending to and receiving from the given remoteAddress. All received datagrams will be sent to the designated handler actor.

Parameters:

handler - (undocumented)

remoteAddress - (undocumented)

localAddress - (undocumented)

options - (undocumented)

Returns:

(undocumented)

connect

public static UdpConnected.Command connect(ActorRef handler,
                                           java.net.InetSocketAddress remoteAddress,
                                           java.lang.Iterable<Inet.SocketOption> options)

Connect without specifying the localAddress.

Parameters:

handler - (undocumented)

remoteAddress - (undocumented)

options - (undocumented)

Returns:

(undocumented)

connect

public static UdpConnected.Command connect(ActorRef handler,
                                           java.net.InetSocketAddress remoteAddress)

Connect without specifying the localAddress or options.

Parameters:

handler - (undocumented)

remoteAddress - (undocumented)

Returns:

(undocumented)

send

public static UdpConnected.Command send(ByteString data,
                                        java.lang.Object ack)

This message is understood by the connection actors to send data to their designated destination. The connection actor will respond with UdpConnected.CommandFailed if the send could not be enqueued to the O/S kernel because the send buffer was full. If the given ack is not of type UdpConnected.NoAck the connection actor will reply with the given object as soon as the datagram has been successfully enqueued to the O/S kernel.

Parameters:

data - (undocumented)

ack - (undocumented)

Returns:

(undocumented)

send

public static UdpConnected.Command send(ByteString data)

Send without requesting acknowledgment.

Parameters:

data - (undocumented)

Returns:

(undocumented)

disconnect

public static UdpConnected.Command disconnect()

Send this message to a connection actor (which had previously sent the UdpConnected.Connected message) in order to close the socket. The connection actor will reply with a UdpConnected.Disconnected message.

Returns:

(undocumented)

noAck

public static UdpConnected.NoAck noAck(java.lang.Object token)

Each UdpConnected.Send can optionally request a positive acknowledgment to be sent to the commanding actor. If such notification is not desired the UdpConnected.Send.ack() must be set to an instance of this class. The token contained within can be used to recognize which write failed when receiving a UdpConnected.CommandFailed message.

Parameters:

token - (undocumented)

Returns:

(undocumented)

noAck

public static UdpConnected.NoAck noAck()

Default UdpConnected.NoAck instance which is used when no acknowledgment information is explicitly provided. Its “token” is null.

Returns:

(undocumented)

suspendReading

public static UdpConnected.Command suspendReading()

Send this message to a listener actor (which sent a Udp.Bound message) to have it stop reading datagrams from the network. If the O/S kernel’s receive buffer runs full then subsequent datagrams will be silently discarded. Re-enable reading from the socket using the UdpConnected.ResumeReading command.

Returns:

(undocumented)

resumeReading

public static UdpConnected.Command resumeReading()

This message must be sent to the listener actor to re-enable reading from the socket after a UdpConnected.SuspendReading command.

Returns:

(undocumented)