org.ws4d.java.communication.connection.udp

Class UDPClient

java.lang.Object

org.ws4d.java.util.TimedEntry

org.ws4d.java.communication.connection.udp.UDPClient

Direct Known Subclasses:

SOAPoverUDPClient

public abstract class UDPClient
extends TimedEntry

UDP client which allows the sending of UDP datagram packets.

Constructor Summary

Constructors

Constructor and Description
UDPClient(int localPort, AddressFilter filter, UDPDatagramHandler handler, java.lang.String comManId)
UDPClient(IPAddress localAddress, int localPort, NetworkInterface iface, AddressFilter filter, UDPDatagramHandler handler, java.lang.String comManId, boolean forceMulticastSocket)

Method Summary

Modifier and Type	Method and Description
void	close() Closes an existing UDP listener.
void	ensureOpen()
NetworkInterface	getIface()
IPAddress	getIPAddress()
int	getPort()
boolean	hasListener()
boolean	isClosed() Returns true if the client is closed and cannot be used for a request, or false if the client can still be used.
void	send(Message message, AttributedURI optionalMessageId, IPConnectionInfo connectionInfo, Datagram datagram) Creates a UDP datagram socket and uses this socket to send the given data as UDP datagram packet.
protected void	timedOut() Runs what should be done at time out.

Methods inherited from class org.ws4d.java.util.TimedEntry

isDisabled, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UDPClient

public UDPClient(IPAddress localAddress,
                 int localPort,
                 NetworkInterface iface,
                 AddressFilter filter,
                 UDPDatagramHandler handler,
                 java.lang.String comManId,
                 boolean forceMulticastSocket)
          throws java.io.IOException

Throws:

java.io.IOException

UDPClient

public UDPClient(int localPort,
                 AddressFilter filter,
                 UDPDatagramHandler handler,
                 java.lang.String comManId)
          throws java.io.IOException

Throws:

java.io.IOException

Method Detail

send

public void send(Message message,
                 AttributedURI optionalMessageId,
                 IPConnectionInfo connectionInfo,
                 Datagram datagram)
          throws java.io.IOException

Creates a UDP datagram socket and uses this socket to send the given data as UDP datagram packet.

A listener is started for the created UDP datagram socket. This listener will exist for this given time and handle incoming UDP messages for the created UDP datagram socket.

An incoming UDP message will be forwarded to the given UDPDatagramHandler which can handle the UDP datagram packet.

The listener should be closed with the close() method.

Parameters:

dstAddress - destination address of the UDP datagram packet.

dstPort - destination port of the UDP datagram packet.

data - the byte array which contains the data.

len - the length of bytes inside the byte array which should be sent.

handler - this handler will handle the incoming UDP datagram packets.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes an existing UDP listener.

A listener is started if the method #send(String, int, byte[], int, UDPDatagramHandler) is used.

Throws:

java.io.IOException

ensureOpen

public void ensureOpen()
                throws java.io.IOException

Throws:

java.io.IOException

isClosed

public boolean isClosed()

Returns true if the client is closed and cannot be used for a request, or false if the client can still be used.

Returns:

true if the client is closed and cannot be used for a request, or false if the client can still be used.

getIface

public NetworkInterface getIface()

Returns:

the ifaceName

getIPAddress

public IPAddress getIPAddress()

getPort

public int getPort()

hasListener

public boolean hasListener()

timedOut

protected void timedOut()

Description copied from class: TimedEntry

Runs what should be done at time out. Will be called by the Watchdog at time out.

Specified by:

timedOut in class TimedEntry