type
constructors
make |
Make a new unbound UDP socket. |
---|
methods
bind |
Bind this socket to the specified local address. |
---|---|
close |
Close this socket. |
config |
Get the |
connect |
Connect this socket to the specified address and port. |
disconnect |
Disconnect this socket from its remote address. |
isBound |
Is this socket bound to a local address and port. |
isClosed |
Is this socket closed. |
isConnected |
Is this socket "connected" to a specific remote host. |
localAddr |
Get the bound local address or null if unbound. |
localPort |
Get the bound local port or null if unbound. |
options |
Access the SocketOptions used to tune this socket. |
receive |
Receive a packet on this socket's bound local address. |
remoteAddr |
Get the remote address or null if not connected to a specific end point. |
remotePort |
Get the remote port or null if not connected to a specific end point. |
send |
Send the packet to its specified remote endpoint. |
Slot Details
bind
close
config
src
SocketConfig config()
Get the socket configuration
for this socket.
connect
disconnect
isBound
isClosed
isConnected
localAddr
localPort
make
src
new make(SocketConfig config := SocketConfig.cur())
Make a new unbound UDP socket. The socket will be configured using the given socket configuration
. The following configuration applies to UDP sockets:
options
src
@Deprecated { msg="Use SocketConfig" }
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
src
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. Use Buf.flip
to ready the buffer to read from start. 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
remotePort
send
src
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.