com.tivoli.twg.netipc
Class TWGUDPSocket

java.lang.Object
  extended bycom.tivoli.twg.netipc.TWGDatagramSocket
      extended bycom.tivoli.twg.netipc.TWGUDPSocket

public class TWGUDPSocket
extends TWGDatagramSocket

Each instance of this TWGDatagramSocket subclass provides a UDP datagram socket which receives datagrams on a specific port.


Field Summary
static java.lang.String DEF_MULTICAST_ADDR
           
static int DEFAULT_PORT_NUMBER
           
static int DISCARD_PORT
           
static java.lang.String DRIVER_NAME
           
static java.lang.String GENERAL_BROADCAST_ADDRESS
           
static java.lang.String PROP_EXT
           
 
Fields inherited from class com.tivoli.twg.netipc.TWGDatagramSocket
data_ack_timeout, DATA_ACK_TIMEOUT, data_recv_timeout, DATA_RECV_TIMEOUT, default_window_size, DEFAULT_WINDOW_SIZE, ENCRYPTION_OVERHEAD, is_reliable, IS_RELIABLE, max_data_retries, MAX_DATA_RETRIES, max_datagram_size, MAX_DATAGRAM_SIZE, max_recv_ack_retries, MAX_RECV_ACK_RETRIES, max_send_ack_retries, MAX_SEND_ACK_RETRIES, max_send_init_retries, MAX_SEND_INIT_RETRIES, max_xfer_wait_time, MAX_XFER_WAIT_TIME, protocol_name, recv_ack_timeout, RECV_ACK_TIMEOUT, send_done_timeout, SEND_DONE_TIMEOUT, send_init_timeout, SEND_INIT_TIMEOUT, simple_send_timeout, SIMPLE_SEND_TIMEOUT
 
Constructor Summary
TWGUDPSocket()
          Default constructor
 
Method Summary
 void BroadcastDatagram(byte[] b, int len)
          Broadcast datagram to all configured broadcast addresses
 void BroadcastDatagram(byte[] b, int len, int port)
           
 void BroadcastDatagramOnDiscardPort(byte[] b, int len)
          Broadcast datagram to discard port over socket (new in v3.10)
 void Close()
          Close socket
 java.lang.String GetDriverName()
          Return string representing name of datagram socket driver
 TWGNetAddress GetNetAddress(java.lang.String address_name)
          Generate TWGNetAddress instance from specified address name
 java.lang.String NormalizeAddressName(java.lang.String name)
          Return normalized format of the specified address name
 TWGReceivedDatagram ReceiveDatagram()
          Receive datagram from socket
 void SendDatagram(TWGNetAddress target_addr, byte[] b, int len)
          Send datagram over socket
 void SendDatagram(TWGNetAddress target_addr, byte[] b, int off, int len)
          Send datagram over socket
 void Start(java.lang.String name, java.lang.String init_str)
          Initialize this datagram socket provider
 
Methods inherited from class com.tivoli.twg.netipc.TWGDatagramSocket
GetDataAckTimeout, GetDataRecvTimeout, GetDefaultWindowSize, GetMaxDatagramSize, GetMaxDataRetries, GetMaxRecvAckRetries, GetMaxSendAckRetries, GetMaxSendDatagramSize, GetMaxSendInitRetries, GetMaxXferWaitTime, getProtocolName, GetRecvAckTimeout, GetSendDoneTimeout, GetSendInitTimeout, GetSimpleSendTimeout, IsReliable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DRIVER_NAME

public static final java.lang.String DRIVER_NAME
See Also:
Constant Field Values

DEFAULT_PORT_NUMBER

public static final int DEFAULT_PORT_NUMBER
See Also:
Constant Field Values

DISCARD_PORT

public static final int DISCARD_PORT
See Also:
Constant Field Values

GENERAL_BROADCAST_ADDRESS

public static final java.lang.String GENERAL_BROADCAST_ADDRESS
See Also:
Constant Field Values

DEF_MULTICAST_ADDR

public static final java.lang.String DEF_MULTICAST_ADDR
See Also:
Constant Field Values

PROP_EXT

public static final java.lang.String PROP_EXT
See Also:
Constant Field Values
Constructor Detail

TWGUDPSocket

public TWGUDPSocket()
Default constructor

Method Detail

Start

public void Start(java.lang.String name,
                  java.lang.String init_str)
           throws java.net.SocketException,
                  TWGIPCTransportException
Description copied from class: TWGDatagramSocket
Initialize this datagram socket provider

Overrides:
Start in class TWGDatagramSocket
Parameters:
name - unique name used in IPC paths (e.g., "TCPIP")
init_str - initialization string to specify protocol-specific parameters
Throws:
java.net.SocketException
TWGIPCTransportException

SendDatagram

public void SendDatagram(TWGNetAddress target_addr,
                         byte[] b,
                         int off,
                         int len)
                  throws java.io.IOException
Send datagram over socket

Specified by:
SendDatagram in class TWGDatagramSocket
Parameters:
target_addr - target address
b - source buffer
off - index of first byte to write from buffer
len - number of bytes to write from buffer
Throws:
java.io.IOException - if error during write operation
See Also:
TWGNetAddress

SendDatagram

public void SendDatagram(TWGNetAddress target_addr,
                         byte[] b,
                         int len)
                  throws java.io.IOException
Send datagram over socket

Specified by:
SendDatagram in class TWGDatagramSocket
Parameters:
target_addr - target address
b - source buffer
len - number of bytes to write from buffer
Throws:
java.io.IOException - if error during write operation
See Also:
TWGNetAddress

BroadcastDatagram

public void BroadcastDatagram(byte[] b,
                              int len)
                       throws java.io.IOException
Broadcast datagram to all configured broadcast addresses

Specified by:
BroadcastDatagram in class TWGDatagramSocket
Parameters:
b - - source buffer
len - - number of bytes to write from buffer
Throws:
java.io.IOException - - if error during write operation

BroadcastDatagramOnDiscardPort

public void BroadcastDatagramOnDiscardPort(byte[] b,
                                           int len)
                                    throws java.io.IOException
Description copied from class: TWGDatagramSocket
Broadcast datagram to discard port over socket (new in v3.10)

Overrides:
BroadcastDatagramOnDiscardPort in class TWGDatagramSocket
Parameters:
b - - source buffer
len - - number of bytes to write from buffer
Throws:
java.io.IOException - - if error during write operation

BroadcastDatagram

public void BroadcastDatagram(byte[] b,
                              int len,
                              int port)
                       throws java.io.IOException
Throws:
java.io.IOException

ReceiveDatagram

public TWGReceivedDatagram ReceiveDatagram()
                                    throws java.io.IOException
Receive datagram from socket

Specified by:
ReceiveDatagram in class TWGDatagramSocket
Returns:
TWGReceivedDatagram - datagram received
Throws:
java.io.IOException - - if error during receive operation
See Also:
TWGReceivedDatagram

Close

public void Close()
           throws java.io.IOException
Close socket

Specified by:
Close in class TWGDatagramSocket
Throws:
java.io.IOException - - if error during termination

NormalizeAddressName

public java.lang.String NormalizeAddressName(java.lang.String name)
                                      throws TWGNetAddressException
Return normalized format of the specified address name

Specified by:
NormalizeAddressName in class TWGDatagramSocket
Parameters:
name - address name to normalize
Returns:
String in format "%d.%d.%d.%d"
Throws:
TWGNetAddressException - if specified address name not resolved

GetNetAddress

public TWGNetAddress GetNetAddress(java.lang.String address_name)
                            throws TWGNetAddressException
Generate TWGNetAddress instance from specified address name

Specified by:
GetNetAddress in class TWGDatagramSocket
Parameters:
address_name - normalized address name
Returns:
TWGNetAddress instance from specified name or null if name was not resolved
Throws:
TWGNetAddressException - if failed to resolve name to address

GetDriverName

public java.lang.String GetDriverName()
Return string representing name of datagram socket driver

Specified by:
GetDriverName in class TWGDatagramSocket
Returns:
string name of driver