Fantom

 

const class

inet::UdpSocket

sys::Obj
  inet::UdpSocket

UdpSocket manages a UDP/IP datagram endpoint.

Note: UdpSocket is marked as a const class to give protocol developers the flexibility to process sockets on multiple threads. However UdpSocket is inherently thread unsafe - therefore it is the developers responsibility to use this API in a thread safe manner.

Slots

bind

native This bind(IpAddr? addr, Int? port)

Bind this socket to the specified local address. If addr is null then the default IpAddr for the local host is selected. If port is null an ephemeral port is selected. Throw IOErr if the port is already bound or the bind fails. Return this.

close

native Bool close()

Close this socket. This method is guaranteed to never throw an IOErr. Return true if the socket was closed successfully or false if the socket was closed abnormally.

connect

native This connect(IpAddr addr, Int port)

Connect this socket to the specified address and port. Once connected packets may only be send to the remote using this socket.

disconnect

native This disconnect()

Disconnect this socket from its remote address. Do nothing if not connected. Return this.

isBound

native Bool isBound()

Is this socket bound to a local address and port.

isClosed

native Bool isClosed()

Is this socket closed.

isConnected

native Bool isConnected()

Is this socket "connected" to a specific remote host. Since UDP is not session oriented, connected just means we've used connect() to predefine the remote address where we want to send packets.

localAddr

native IpAddr? localAddr()

Get the bound local address or null if unbound.

localPort

native Int? localPort()

Get the bound local port or null if unbound.

make

new make()

Make a new unbound UDP socket.

options

native SocketOptions options()

Access the SocketOptions used to tune this socket. The following options apply to UdpSockets:

  • broadcast
  • receiveBufferSize
  • sendBufferSize
  • reuseAddr
  • receiveBufferSize
  • trafficClass Accessing other option fields will throw UnsupportedErr.
receive

native UdpPacket receive(UdpPacket? packet := null)

Receive a packet on this socket's bound local address. The resulting packet is filled in with the sender's address and port. This method blocks until a packet is received. If this socket's receiveTimeout option is configured, then receive will timeout with an IOErr.

The packet data is read into the Buf starting at it's current position. The buffer is not grown - at most Buf.capacity bytes are received. If the received message is longer than the packet's capacity then the message is silently truncated (weird Java behavior). Upon return the Buf size and position are updated to reflect the bytes read. If packet is null, then a new packet is created with a capacity of 1kb. The packet data must always be a memory backed buffer.

remoteAddr

native IpAddr? remoteAddr()

Get the remote address or null if not connected to a specific end point.

remotePort

native Int? remotePort()

Get the remote port or null if not connected to a specific end point.

send

native Void send(UdpPacket packet)

Send the packet to its specified remote endpoint. If this is socket is connected to a specific remote address, then the packet's address and port must be null or ArgErr is thrown. Throw IOErr on error.

The number of bytes sent is buf.remaining; upon return the buf is drained and position is advanced.