de.fu_berlin.inf.dpp.negotiation.SessionNegotiation Class Reference

Inheritance diagram for de.fu_berlin.inf.dpp.negotiation.SessionNegotiation:

List of all members.

Public Member Functions
	SessionNegotiation (final String negotiationID, final JID peer, final String description, final ISarosContext sarosContext)
JID	getPeer ()
String	getDescription ()
final String	getID ()
Protected Member Functions
void	notifyCancellation (SarosCancellationException exception)
final Packet	collectPacket (PacketCollector collector, long timeout) throws SarosCancellationException
void	notifyTerminated (NegotiationListener listener)
Protected Attributes
ITransmitter	transmitter
IReceiver	receiver
SessionNegotiationHookManager	hookManager
final String	description
JID	peer
final String	peerNickname
ISarosSession	sarosSession
Static Protected Attributes
static final long	PACKET_TIMEOUT
static final long	INVITATION_ACCEPTED_TIMEOUT

---

Detailed Description

Author:

rdjemili

sotitas

---

Constructor & Destructor Documentation

de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.SessionNegotiation	(	final String	negotiationID,
		final JID	peer,
		final String	description,
		final ISarosContext	sarosContext
	)

---

Member Function Documentation

final Packet de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.collectPacket	(	PacketCollector	collector,
		long	timeout
	)		throws SarosCancellationException [protected]

Returns the next packet from a collector.

Parameters:

collector	the collector to monitor
timeout	the amount of time to wait for the next packet (in milliseconds)

Returns:

the collected packet or null if no packet was received

Exceptions:

SarosCancellationException

if the process was canceled

String de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.getDescription

(

)

Returns:

the user-provided informal description that can be provided with an invitation.

final String de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.getID

(

)

Returns the ID of this negotiation.

Returns:

the ID

JID de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.getPeer

(

)

void de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.notifyCancellation

(

SarosCancellationException

cancellationCause

)

[protected, virtual]

This method is called after terminateProcess decides to cancel the current process. It is up to the implementing class to forward this notification.

Parameters:

cancellationCause

the cause of the cancellation

Implements de.fu_berlin.inf.dpp.negotiation.CancelableProcess.

void de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.notifyTerminated

(

NegotiationListener

listener

)

[protected, virtual]

Informs the listener, that the process is terminated. Otherwise, the SessionManager would block the execution and wait until the process is terminated

Parameters:

listener

to notify

Implements de.fu_berlin.inf.dpp.negotiation.CancelableProcess.

---

Member Data Documentation

final String de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.description [protected]

SessionNegotiationHookManager de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.hookManager [protected]

final long de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.INVITATION_ACCEPTED_TIMEOUT [static, protected]

Initial value:

 Long.getLong(
        "de.fu_berlin.inf.dpp.negotiation.session.INVITATION_ACCEPTED_TIMEOUT",
        600000L)

Timeout on how long the session negotiation should wait for the remote user to accept the invitation

final long de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.PACKET_TIMEOUT [static, protected]

Initial value:

 Long.getLong(
        "de.fu_berlin.inf.dpp.negotiation.session.PACKET_TIMEOUT", 30000L)

Timeout for all packet exchanges during the session negotiation

JID de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.peer [protected]

final String de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.peerNickname [protected]

IReceiver de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.receiver [protected]

ISarosSession de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.sarosSession [protected]

ITransmitter de.fu_berlin.inf.dpp.negotiation.SessionNegotiation.transmitter [protected]