AppSocket

java.lang.Object
- usr.router.AppSocket

```
public class AppSocket
extends java.lang.Object
```
An AppSocket acts like a socket, and talks to the AppSocketMux in order to get Datagrams in and out of applications and into the Router.

Constructor Summary

Constructors
Constructor and Description
`AppSocket(Router r)` Constructs an AppSocket and binds it to any available port on the local Router.
`AppSocket(Router r, Address addr, int port)` Construct an AppSocket attached to the specified Router.
`AppSocket(Router r, int port)` Construct an AppSocket attached to the specified Router.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`bind(int port)` Binds this DatagramSocket to a port.
`void`	`close()` Close this socket.
`void`	`connect(Address address, int port)` Connects the socket to a remote address for this socket.
`void`	`connect(SocketAddress sockaddr)` Connects the socket to a remote address for this socket.
`void`	`disconnect()` Disconnects the socket.
`Address`	`getLocalAddress()` Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
`int`	`getLocalPort()` Returns the local port for this socket to which this socket is bound.
`int`	`getPort()` Returns the remote port for this socket.
`Address`	`getRemoteAddress()` Returns the address to which this socket is connected.
`int`	`getSoTimeout()` Retrive setting for SO_TIMEOUT.
`boolean`	`isBound()` Returns the bound state of the socket.
`boolean`	`isClosed()` Returns the bound state of the socket.
`boolean`	`isConnected()` Returns the connection state of the socket.
`Datagram`	`receive()` Receives a datagram from this socket.
`void`	`send(Datagram dg)` Send a datagram from this socket.
`void`	`setSoTimeout(int timeout)` Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds.
`java.lang.String`	`toString()` toString.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AppSocket
```
public AppSocket(Router r)
          throws java.net.SocketException
```
    Constructs an AppSocket and binds it to any available port on the local Router. The socket will be bound to the wildcard address, an IP address chosen by the Router.
    
    Throws:
    
    java.net.SocketException
  - AppSocket
```
public AppSocket(Router r,
         int port)
          throws java.net.SocketException
```
    Construct an AppSocket attached to the specified Router. It binds to the local port.
    
    Throws:
    
    java.net.SocketException
  - AppSocket
```
public AppSocket(Router r,
         Address addr,
         int port)
          throws java.net.SocketException
```
    Construct an AppSocket attached to the specified Router. It connects to the Socket at the remote address and remote port. When a socket is connected to a remote address, packets may only be sent to or received from that address.
    
    Throws:
    
    java.net.SocketException
- Method Detail
  - bind
```
public void bind(int port)
          throws java.net.SocketException
```
    Binds this DatagramSocket to a port.
    
    Throws:
    
    java.net.SocketException
  - connect
```
public void connect(Address address,
           int port)
```
    Connects the socket to a remote address for this socket. When a socket is connected to a remote address, packets may only be sent to or received from that address. By default a datagram socket is not connected.
  - connect
```
public void connect(SocketAddress sockaddr)
```
    Connects the socket to a remote address for this socket. When a socket is connected to a remote address, packets may only be sent to or received from that address. By default a datagram socket is not connected.
  - getPort
```
public int getPort()
```
    Returns the remote port for this socket. Returns -1 if the socket is not connected.
  - getRemoteAddress
```
public Address getRemoteAddress()
```
    Returns the address to which this socket is connected. Returns null if the socket is not connected.
  - isConnected
```
public boolean isConnected()
```
    Returns the connection state of the socket.
    
    Returns:
    true if the socket succesfuly connected to a server
  - isBound
```
public boolean isBound()
```
    Returns the bound state of the socket.
    
    Returns:
    true if the socket succesfuly bound to an address
  - isClosed
```
public boolean isClosed()
```
    Returns the bound state of the socket.
    
    Returns:
    true if the socket is closed.
  - getLocalPort
```
public int getLocalPort()
```
    Returns the local port for this socket to which this socket is bound.
  - getLocalAddress
```
public Address getLocalAddress()
```
    Returns the address of the endpoint this socket is bound to, or null if it is not bound yet.
  - send
```
public void send(Datagram dg)
          throws java.net.SocketException,
                 java.net.NoRouteToHostException
```
    Send a datagram from this socket. The Datagram includes information indicating the data to be sent, its length, the address of the remote router, and the port number on the remote router.
    
    Throws:
    
    java.net.SocketException
    
    java.net.NoRouteToHostException
  - receive
```
public Datagram receive()
                 throws java.net.SocketException,
                        SocketTimeoutException
```
    Receives a datagram from this socket. When this method returns, the Datagram is filled with the data received. The datagram also contains the sender's address, and the port number on the sender's machine. This method blocks until a datagram is received. TODO: check if this needs to be synchronized for multiple threads
    
    Throws:
    
    java.net.SocketException
    
    SocketTimeoutException
  - disconnect
```
public void disconnect()
```
    Disconnects the socket. This does nothing if the socket is not connected.
  - close
```
public void close()
```
    Close this socket.
  - getSoTimeout
```
public int getSoTimeout()
                 throws java.net.SocketException
```
    Retrive setting for SO_TIMEOUT. 0 returns implies that the option is disabled (i.e., timeout of infinity).
    
    Throws:
    
    java.net.SocketException
  - setSoTimeout
```
public void setSoTimeout(int timeout)
                  throws java.net.SocketException
```
    Enable/disable SO_TIMEOUT with the specified timeout, in milliseconds. With this option set to a non-zero timeout, a call to receive() for this DatagramSocket will block for only this amount of time. If the timeout expires, a java.net.SocketTimeoutException is raised, though the DatagramSocket is still valid. The option must be enabled prior to entering the blocking operation to have effect. The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout. Parameters: timeout - the specified timeout in milliseconds.
    
    Throws:
    
    java.net.SocketException
  - toString
```
public java.lang.String toString()
```
    toString.
    
    Overrides:
    
    toString in class java.lang.Object

Class AppSocket

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AppSocket

AppSocket

AppSocket

Method Detail

bind

connect

connect

getPort

getRemoteAddress

isConnected

isBound

isClosed

getLocalPort

getLocalAddress

send

receive

disconnect

close

getSoTimeout

setSoTimeout

toString