UnetSocket (UnetStack 3.4.0 API)

org.arl.unet.api.UnetSocket

All Implemented Interfaces and Traits:

Closeable
```
public class UnetSocket
extends Object
```
Unet socket for transmission/reception of datagrams. This class is not thread-safe.

Field Summary

Fields
Modifiers	Name	Description
`protected static int`	`BLOCKING`
`protected static int`	`NON_BLOCKING`
`protected static long`	`REQUEST_TIMEOUT`
`protected Gateway`	`gw`
`protected int`	`localProtocol`
`protected AgentID`	`provider`
`protected int`	`remoteAddress`
`protected int`	`remoteProtocol`
`protected long`	`timeout`
`protected Thread`	`waiting`

Properties Summary

Properties
Type	Name and description
`long`	`timeout`

Constructor Summary

Constructors
Constructor and description
`UnetSocket (Container container)` Creates a socket running in a container.
`UnetSocket (String hostname, int port)` Creates a socket connected to a master container over TCP/IP.
`UnetSocket (String devname, int baud, String settings)` Creates a socket connected to a master container over RS232.
`UnetSocket (BaseGroovyScript script)` Creates a socket connected to a local container running the shell from which the base script runs.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`AgentID`	`agent(String name)` Gets a named AgentID for low-level access to UnetStack.
	`AgentID`	`agentForService(String svc)` Gets an AgentID providing a specified service for low-level access to UnetStack.
	`AgentID`	`agentForService(Enum<?> svc)` Gets an AgentID providing a specified service for low-level access to UnetStack.
	`AgentID[]`	`agentsForService(String svc)` Gets a list of AgentIDs providing a specified service for low-level access to UnetStack.
	`AgentID[]`	`agentsForService(Enum<?> svc)` Gets a list of AgentIDs providing a specified service for low-level access to UnetStack.
	`boolean`	`bind(int protocol)` Binds a socket to listen to a specific protocol datagrams.
	`void`	`cancel()` Cancels an ongoing blocking receive().
	`void`	`close()` Closes the socket.
	`boolean`	`connect(int to, int protocol)` Sets the default destination address and destination protocol number for datagrams sent using this socket.
	`void`	`disconnect()` Resets the default destination address to undefined, and the default protocol number to Protocol.DATA.
	`Gateway`	`getGateway()` Gets a Gateway to provide low-level access to UnetStack.
	`int`	`getLocalAddress()` Gets the local node address.
	`int`	`getLocalProtocol()` Gets the protocol number that the socket is bound to.
	`int`	`getRemoteAddress()` Gets the default destination node address for a connected socket.
	`int`	`getRemoteProtocol()` Gets the default transmission protocol number.
	`long`	`getTimeout()` Gets the timeout for datagram reception.
	`Integer`	`host(String nodeName)` Resolve node name to node address.
	`protected void`	`init()`
	`boolean`	`isBound()` Checks if a socket is bound.
	`boolean`	`isClosed()` Checks if a socket is closed.
	`boolean`	`isConnected()` Checks if a socket is connected, i.e., has a default destination address and protocol number.
	`DatagramNtf`	`receive()` Receives a datagram sent to the local node and the bound protocol number.
	`boolean`	`send(byte[] data)` Transmits a datagram to the default node address using the default protocol.
	`boolean`	`send(byte[] data, int to)` Transmits a datagram to the specified node address using the default protocol.
	`boolean`	`send(byte[] data, int to, int protocol)` Transmits a datagram to the specified node address using the specified protocol.
	`boolean`	`send(DatagramReq req)` Transmits a datagram to the specified node address using the specified protocol.
	`void`	`setTimeout(long ms)` Sets the timeout for datagram reception.
	`void`	`unbind()` Unbinds a socket so that it listens to all unreserved protocols.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected static final int BLOCKING
  - protected static final int NON_BLOCKING
  - protected static final long REQUEST_TIMEOUT
  - protected Gateway gw
  - protected int localProtocol
  - protected AgentID provider
  - protected int remoteAddress
  - protected int remoteProtocol
  - protected long timeout
  - protected Thread waiting
- Property Detail
  - long timeout
- Constructor Detail
  - public UnetSocket(Container container)
    
    Creates a socket running in a container.
    Parameters:
    container - container
  - public UnetSocket(String hostname, int port)
    
    Creates a socket connected to a master container over TCP/IP.
    Parameters:
    hostname - host name or IP address of master container
    port - TCP port number for master container
  - public UnetSocket(String devname, int baud, String settings)
    
    Creates a socket connected to a master container over RS232.
    Parameters:
    devname - RS232 device name
    baud - RS232 baud rate
    settings - RS232 settings string (e.g. "N81")
  - public UnetSocket(BaseGroovyScript script)
    
    Creates a socket connected to a local container running the shell from which the base script runs. This is useful in a shell script to invoke as:
```
 sock = new org.arl.unet.api.UnetSocket(this)
 
```
    Parameters:
    script - Groovy script object connected with the local container
- Method Detail
  - public AgentID agent(String name)
    
    Gets a named AgentID for low-level access to UnetStack.
    Parameters:
    name - name of the agent
    Returns:
    AgentID of a named agent
  - public AgentID agentForService(String svc)
    
    Gets an AgentID providing a specified service for low-level access to UnetStack.
    Parameters:
    svc - name of the service
    Returns:
    AgentID of an agent providing the service
  - public AgentID agentForService(Enum<?> svc)
    
    Gets an AgentID providing a specified service for low-level access to UnetStack.
    Parameters:
    svc - name of the service
    Returns:
    AgentID of an agent providing the service
  - public AgentID[] agentsForService(String svc)
    
    Gets a list of AgentIDs providing a specified service for low-level access to UnetStack.
    Parameters:
    svc - name of the service
    Returns:
    List of AgentIDs of agents providing the service
  - public AgentID[] agentsForService(Enum<?> svc)
    
    Gets a list of AgentIDs providing a specified service for low-level access to UnetStack.
    Parameters:
    svc - name of the service
    Returns:
    List of AgentIDs of agents providing the service
  - public boolean bind(int protocol)
    
    Binds a socket to listen to a specific protocol datagrams.
    Protocol numbers between Protocol.DATA+1 to Protocol.USER-1 are reserved protocols and cannot be bound. Unbound sockets listen to all unreserved protocols.
    Parameters:
    protocol - protocol number to listen for
    Returns:
    true on success, false on failure
  - public void cancel()
    
    Cancels an ongoing blocking receive().
  - @Override public void close()
    
    Closes the socket. The socket functionality may not longer be accessed after this method is called.
  - public boolean connect(int to, int protocol)
    
    Sets the default destination address and destination protocol number for datagrams sent using this socket. The defaults can be overridden for specific send() calls.
    The default protocol number when a socket is opened is Protocol.DATA. The default node address is undefined. Protocol numbers between Protocol.DATA+1 to Protocol.USER-1 are considered reserved, and cannot be used for sending datagrams using the socket.
    Parameters:
    to - default destination node address
    protocol - default protocol number
    Returns:
    true on success, false on failure
  - public void disconnect()
    
    Resets the default destination address to undefined, and the default protocol number to Protocol.DATA.
  - public Gateway getGateway()
    
    Gets a Gateway to provide low-level access to UnetStack.
    Returns:
    gateway
  - public int getLocalAddress()
    
    Gets the local node address.
    Returns:
    local node address, or -1 on error
  - public int getLocalProtocol()
    
    Gets the protocol number that the socket is bound to.
    Returns:
    protocol number if socket is bound, -1 otherwise
  - public int getRemoteAddress()
    
    Gets the default destination node address for a connected socket.
    Returns:
    default destination node address if connected, -1 otherwise
  - public int getRemoteProtocol()
    
    Gets the default transmission protocol number.
    Returns:
    default protocol number used to transmit a datagram
  - public long getTimeout()
    
    Gets the timeout for datagram reception.
    Returns:
    timeout in milliseconds, 0 for non-blocking, or -1 for infinite
  - public Integer host(String nodeName)
    
    Resolve node name to node address.
    Parameters:
    nodeName - name of node to resolve
    Returns:
    address of node, or null if unable to resolve
  - protected void init()
  - public boolean isBound()
    
    Checks if a socket is bound.
    Returns:
    true if bound to a protocol, false if unbound
  - public boolean isClosed()
    
    Checks if a socket is closed.
    Returns:
    true if closed, false is open
  - public boolean isConnected()
    
    Checks if a socket is connected, i.e., has a default destination address and protocol number.
    Returns:
    true if connected, false otherwise
  - public DatagramNtf receive()
    
    Receives a datagram sent to the local node and the bound protocol number. If the socket is unbound, then datagrams with all unreserved protocols are received. Any broadcast datagrams are also received.
    This call blocks until a datagram is availbale, the socket timeout is reached, or until cancel() is called.
    Returns:
    datagram reception notification, or null if none available
  - public boolean send(byte[] data)
    
    Transmits a datagram to the default node address using the default protocol.
    Parameters:
    data - bytes to transmit
    Returns:
    true on success, false on failure
  - public boolean send(byte[] data, int to)
    
    Transmits a datagram to the specified node address using the default protocol.
    Parameters:
    data - bytes to transmit
    to - destination node address
    Returns:
    true on success, false on failure
  - public boolean send(byte[] data, int to, int protocol)
    
    Transmits a datagram to the specified node address using the specified protocol.
    Protocol numbers between Protocol.DATA+1 to Protocol.USER-1 are considered reserved, and cannot be used for sending datagrams using the socket.
    Parameters:
    data - bytes to transmit
    to - destination node address
    protocol - protocol number
    Returns:
    true on success, false on failure
  - public boolean send(DatagramReq req)
    
    Transmits a datagram to the specified node address using the specified protocol.
    Protocol numbers between Protocol.DATA+1 to Protocol.USER-1 are considered reserved, and cannot be used for sending datagrams using the socket.
    Parameters:
    req - datagram transmission request
    Returns:
    true on success, false on failure
  - public void setTimeout(long ms)
    
    Sets the timeout for datagram reception. The default timeout is infinite, i.e., the receive() call blocks forever. A timeout of 0 means the receive() call is non-blocking.
    Parameters:
    ms - timeout in milliseconds, or -1 for infinite timeout
  - public void unbind()
    
    Unbinds a socket so that it listens to all unreserved protocols.
    Protocol numbers between Protocol.DATA+1 to Protocol.USER-1 are considered reserved.

Summary:
Field
Property
Constructor
Method

[Java] Class UnetSocket

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final int BLOCKING

protected static final int NON_BLOCKING

protected static final long REQUEST_TIMEOUT

protected Gateway gw

protected int localProtocol

protected AgentID provider

protected int remoteAddress

protected int remoteProtocol

protected long timeout

protected Thread waiting

Property Detail

long timeout

Constructor Detail

public UnetSocket(Container container)

public UnetSocket(String hostname, int port)

public UnetSocket(String devname, int baud, String settings)

public UnetSocket(BaseGroovyScript script)

Method Detail

public AgentID agent(String name)

public AgentID agentForService(String svc)

public AgentID agentForService(Enum<?> svc)

public AgentID[] agentsForService(String svc)

public AgentID[] agentsForService(Enum<?> svc)

public boolean bind(int protocol)

public void cancel()

@Override public void close()

public boolean connect(int to, int protocol)

public void disconnect()

public Gateway getGateway()

public int getLocalAddress()

public int getLocalProtocol()

public int getRemoteAddress()

public int getRemoteProtocol()

public long getTimeout()

public Integer host(String nodeName)

protected void init()

public boolean isBound()

public boolean isClosed()

public boolean isConnected()

public DatagramNtf receive()

public boolean send(byte[] data)

public boolean send(byte[] data, int to)

public boolean send(byte[] data, int to, int protocol)

public boolean send(DatagramReq req)

public void setTimeout(long ms)

public void unbind()