UDPRelayServer (fucksocks 1.0.0 API)

java.lang.Object
- fucksocks.server.UDPRelayServer

All Implemented Interfaces:

Runnable
```
public class UDPRelayServer
extends Object
implements Runnable
```
The class UDPRelayServer represents a UDP relay server.
The UDP relay server will receive datagram packets from a client and transmit them to the specified server. It will also receive datagram packets from other UDP servers and send them to client. UDP relay server must need to know the client's IP address and port to find out where the datagram packet from, because UDP is not long connection protocol.

Version:

1.0

Author:

Youchao Feng

date

Apr 22, 2015 12:54:50 AM

Field Summary

Fields
Modifier and Type Field and Description

protected static org.slf4j.Logger logger
Logger that subclasses also can use.

Fields
Modifier and Type	Field and Description
`protected static org.slf4j.Logger`	`logger` Logger that subclasses also can use.

Constructor Summary

Constructors
Constructor and Description
`UDPRelayServer()` Constructs a `UDPRelayServer` instance.
`UDPRelayServer(InetAddress clientInetAddress, int clientPort)` Constructs a `UDPRelayServer` instance with client's IP address and port.
`UDPRelayServer(SocketAddress clientSocketAddresss)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getBufferSize()` Returns buffer size.
`InetAddress`	`getClientAddresss()` Returns client's IP address.
`int`	`getClientPort()` Returns client's port.
`Socks5DatagramPacketHandler`	`getDatagramPacketHandler()` Returns datagram packet handler.
`DatagramSocket`	`getServer()` Return UDP server.
`protected boolean`	`isFromClient(DatagramPacket packet)` Returns `true` if the the datagram packet from client.
`boolean`	`isRunning()` Return `true` if the UDP relay server is running.
`void`	`run()`
`void`	`setBufferSize(int bufferSize)` Sets buffer size.
`void`	`setClientAddresss(InetAddress clientAddresss)` Sets client's IP address.
`void`	`setClientPort(int clientPort)` Sets client's port.
`void`	`setDatagramPacketHandler(Socks5DatagramPacketHandler datagramPacketHandler)` Sets datagram packet handler.
`void`	`setServer(DatagramSocket server)` Sets UDP server.
`SocketAddress`	`start()` Starts a UDP relay server.
`void`	`stop()` Stop the UDP relay server.

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

- Field Detail
  - logger
```
protected static final org.slf4j.Logger logger
```
    Logger that subclasses also can use.
- Constructor Detail
  - UDPRelayServer
```
public UDPRelayServer()
```
    Constructs a UDPRelayServer instance.
  - UDPRelayServer
```
public UDPRelayServer(InetAddress clientInetAddress,
              int clientPort)
```
    Constructs a UDPRelayServer instance with client's IP address and port. The UDP relay server will use client's IP and port to find out where the datagram packet from.
    
    Parameters:
    clientInetAddress - Client's IP address.
    clientPort - Client's port.
  - UDPRelayServer
```
public UDPRelayServer(SocketAddress clientSocketAddresss)
```
- Method Detail
  - start
```
public SocketAddress start()
                    throws SocketException
```
    Starts a UDP relay server.
    
    Returns:
    Server bind socket address.
    
    Throws:
    
    SocketException - If a SOCKS protocol error occurred.
  - stop
```
public void stop()
```
    Stop the UDP relay server.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - isFromClient
```
protected boolean isFromClient(DatagramPacket packet)
```
    Returns true if the the datagram packet from client.
    
    Parameters:
    packet - Datagram packet the UDP server received.
    
    Returns:
    If the datagram packet is sent from client, it will return true.
  - getServer
```
public DatagramSocket getServer()
```
    Return UDP server.
    
    Returns:
    UDP server.
  - setServer
```
public void setServer(DatagramSocket server)
```
    Sets UDP server.
    
    Parameters:
    server - UDP server.
  - getBufferSize
```
public int getBufferSize()
```
    Returns buffer size.
    
    Returns:
    Buffer size.
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
    Sets buffer size.
    
    Parameters:
    bufferSize - Buffer size.
  - getDatagramPacketHandler
```
public Socks5DatagramPacketHandler getDatagramPacketHandler()
```
    Returns datagram packet handler.
    
    Returns:
    the instance of Socks5DatagramPacketHandler.
  - setDatagramPacketHandler
```
public void setDatagramPacketHandler(Socks5DatagramPacketHandler datagramPacketHandler)
```
    Sets datagram packet handler.
    
    Parameters:
    datagramPacketHandler - Datagram packet handler.
  - getClientAddresss
```
public InetAddress getClientAddresss()
```
    Returns client's IP address.
    
    Returns:
    clinet's IP address.
  - setClientAddresss
```
public void setClientAddresss(InetAddress clientAddresss)
```
    Sets client's IP address.
    
    Parameters:
    clientAddresss - client's IP address.
  - getClientPort
```
public int getClientPort()
```
    Returns client's port.
    
    Returns:
    client's port.
  - setClientPort
```
public void setClientPort(int clientPort)
```
    Sets client's port.
    
    Parameters:
    clientPort - client's port.
  - isRunning
```
public boolean isRunning()
```
    Return true if the UDP relay server is running.
    
    Returns:
    If the UDP relay server is running, it will return true.

Class UDPRelayServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

Constructor Detail

UDPRelayServer

UDPRelayServer

UDPRelayServer

Method Detail

start

stop

run

isFromClient

getServer

setServer

getBufferSize

setBufferSize

getDatagramPacketHandler

setDatagramPacketHandler

getClientAddresss

setClientAddresss

getClientPort

setClientPort

isRunning