Class Udp.Send

This message is understood by the "simple sender" which can be obtained by sending the Udp.SimpleSender query to the Manager as well as by the listener actors which are created in response to Udp.Bind. It will send the given payload data as one UDP datagram to the given target address. The UDP actor will respond with Udp.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 Udp.NoAck the UDP actor will reply with the given object as soon as the datagram has been successfully enqueued to the O/S kernel.

The sending UDP socket's address belongs to the "simple sender" which does not handle inbound datagrams and sends from an ephemeral port; therefore sending using this mechanism is not suitable if replies are expected, use Udp.Bind in that case.

Inheritance
object
Udp.Message
Udp.Command
Udp.Send
Implements
Inherited Members
Namespace: Akka.IO
Assembly: Akka.dll
Syntax
public sealed class Udp.Send : Udp.Command, INoSerializationVerificationNeeded

Constructors

| Edit this page View Source

Send(ByteString, EndPoint, Event)

Creates a new send request to be executed via UDP socket to a addressed to the provided endpoint. Once send completes, this request will acknowledged back on the sender side with an ack object.

Declaration
public Send(ByteString payload, EndPoint target, Udp.Event ack)
Parameters
Type Name Description
ByteString payload

Binary payload to be send.
EndPoint target

An endpoint of the message receiver.
Udp.Event ack

Acknowledgement send back to the sender, once payload has been send through a socket.

Properties

| Edit this page View Source

Ack

Acknowledgement send back to the sender, once Payload has been send through a socket. If it's Udp.NoAck, then no acknowledgement will be send.

Declaration
public Udp.Event Ack { get; }
Property Value
Type Description
Udp.Event
| Edit this page View Source

Payload

A binary payload to be send to the Target. It must fit into a single UDP datagram.

Declaration
public ByteString Payload { get; }
Property Value
Type Description
ByteString
| Edit this page View Source

Target

An endpoint, to which current Payload will be send.

Declaration
public EndPoint Target { get; }
Property Value
Type Description
EndPoint
| Edit this page View Source

WantsAck

Flag determining is a message sender is interested in receving send acknowledgement.

Declaration
public bool WantsAck { get; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

Create(ByteString, EndPoint)

Creates a new send request to be executed via UDP socket to a addressed to the provided endpoint. Once send completes, this request will not be acknowledged on by the sender side.

Declaration
public static Udp.Send Create(ByteString data, EndPoint target)
Parameters
Type Name Description
ByteString data

Binary payload to be send.
EndPoint target

An endpoint of the message receiver.
Returns
Type Description
Udp.Send

A new Send command instance with NoAck as acknowledgment.
| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods