org.ice4j.stunclient

Class BlockingRequestSender

java.lang.Object

org.ice4j.AbstractResponseCollector

org.ice4j.stunclient.BlockingRequestSender

All Implemented Interfaces:

ResponseCollector

public class BlockingRequestSender
extends AbstractResponseCollector

A utility used to flatten the multi-thread architecture of the Stack and execute the discovery process in a synchronized manner. Roughly what happens here is: ApplicationThread: sendMessage() wait(); StackThread: processMessage/Timeout() { saveMessage(); notify(); }

Author:

Emil Ivov, Lubomir Marinov, Aakash Garg

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	ended Determines whether this request sender has completed its course.
private TransportAddress	localAddress The transport address that we are bound on.
private static Logger	logger Our class logger
private StunMessageEvent	responseEvent The StunMessageEvent that contains the response matching our request.
private Object	sendLock A lock object that we are using to synchronize sending.
private StunStack	stunStack The stack that we are using to send requests through.

Constructor Summary

Constructors

Constructor and Description
BlockingRequestSender(StunStack stunStack, TransportAddress localAddress) Creates a new request sender.

Method Summary

Modifier and Type	Method and Description
TransportAddress	getLocalAddress() Returns the local Address on which this Blocking Request Sender is bound to.
protected void	processFailure(BaseStunMessageEvent event) Notifies this ResponseCollector that a transaction described by the specified BaseStunMessageEvent has failed.
void	processResponse(StunResponseEvent evt) Saves the message event and notifies the discoverer thread so that it may resume.
StunMessageEvent	sendRequestAndWaitForResponse(Request request, TransportAddress serverAddress) Sends the specified request and blocks until a response has been received or the request transaction has timed out.
StunMessageEvent	sendRequestAndWaitForResponse(Request request, TransportAddress serverAddress, TransactionID tranID) Sends the specified request and blocks until a response has been received or the request transaction has timed out with given transactionID.

Methods inherited from class org.ice4j.AbstractResponseCollector

processTimeout, processUnreachable

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

Our class logger

stunStack

private final StunStack stunStack

The stack that we are using to send requests through.

localAddress

private final TransportAddress localAddress

The transport address that we are bound on.

responseEvent

private StunMessageEvent responseEvent

The StunMessageEvent that contains the response matching our request.

ended

private boolean ended

Determines whether this request sender has completed its course.

sendLock

private final Object sendLock

A lock object that we are using to synchronize sending.

Constructor Detail

BlockingRequestSender

public BlockingRequestSender(StunStack stunStack,
                             TransportAddress localAddress)

Creates a new request sender.

Parameters:

stunStack - the stack that the sender should send requests through.

localAddress - the TransportAddress that requests should be leaving from.

Method Detail

getLocalAddress

public TransportAddress getLocalAddress()

Returns the local Address on which this Blocking Request Sender is bound to.

Returns:

the localAddress of this RequestSender.

processFailure

protected void processFailure(BaseStunMessageEvent event)

Notifies this ResponseCollector that a transaction described by the specified BaseStunMessageEvent has failed. The possible reasons for the failure include timeouts, unreachable destination, etc. Notifies the discoverer so that it may resume.

Specified by:

processFailure in class AbstractResponseCollector

Parameters:

event - the BaseStunMessageEvent which describes the failed transaction and the runtime type of which specifies the failure reason

See Also:

AbstractResponseCollector.processFailure(BaseStunMessageEvent)

processResponse

public void processResponse(StunResponseEvent evt)

Saves the message event and notifies the discoverer thread so that it may resume.

Parameters:

evt - the newly arrived message event.

sendRequestAndWaitForResponse

public StunMessageEvent sendRequestAndWaitForResponse(Request request,
                                                      TransportAddress serverAddress)
                                               throws StunException,
                                                      IOException

Sends the specified request and blocks until a response has been received or the request transaction has timed out.

Parameters:

request - the request to send

serverAddress - the request destination address

Returns:

the event encapsulating the response or null if no response has been received.

Throws:

IOException - if an error occurs while sending message bytes through the network socket.

IllegalArgumentException - if the apDescriptor references an access point that had not been installed,

StunException - if message encoding fails,

sendRequestAndWaitForResponse

public StunMessageEvent sendRequestAndWaitForResponse(Request request,
                                                      TransportAddress serverAddress,
                                                      TransactionID tranID)
                                               throws StunException,
                                                      IOException

Sends the specified request and blocks until a response has been received or the request transaction has timed out with given transactionID.

Parameters:

request - the request to send

serverAddress - the request destination address

tranID - the TransactionID to set for this reuest.

Returns:

the event encapsulating the response or null if no response has been received.

Throws:

IOException - if an error occurs while sending message bytes through the network socket.

IllegalArgumentException - if the apDescriptor references an access point that had not been installed,

StunException - if message encoding fails,