org.jacorb.orb.policies

Class RelativeRoundtripTimeoutPolicy

public class RelativeRoundtripTimeoutPolicy extends _RelativeRoundtripTimeoutPolicyLocalBase

Specifies a relative timeout for a CORBA roundtrip. It is an upper bound for the time it may take for a request to reach the server, be processed, and the reply delivered back to the client.

Version: $Id: RelativeRoundtripTimeoutPolicy.java,v 1.7 2007/02/14 09:49:53 andre.spiegel Exp $

Author: Andre Spiegel spiegel@gnu.org

Constructor Summary
RelativeRoundtripTimeoutPolicy(Any value)
Constructs a new RelativeRoundtripTimeoutPolicy object from an Any value.
RelativeRoundtripTimeoutPolicy(long relative_expiry)
Convenience constructor for RelativeRoundtripTimeoutPolicy.
Method Summary
Policycopy()
voiddestroy()
intpolicy_type()
longrelative_expiry()
Returns the duration of this timeout, in CORBA time units (100 nanosecond resolution).

Constructor Detail

RelativeRoundtripTimeoutPolicy

public RelativeRoundtripTimeoutPolicy(Any value)
Constructs a new RelativeRoundtripTimeoutPolicy object from an Any value. This is the official CORBA way of constructing this policy (via orb.create_policy()), but JacORB also has a convenience constructor that directly takes the timeout value as a parameter.

Parameters: value an Any that contains the timeout as a CORBA "unsigned long long" value (use Any.insert_ulonglong()). The timeout is specified in CORBA time units (100 nanosecond resolution). If you have a value in milliseconds, multiply that by 10,000.

RelativeRoundtripTimeoutPolicy

public RelativeRoundtripTimeoutPolicy(long relative_expiry)
Convenience constructor for RelativeRoundtripTimeoutPolicy. This constructor is JacORB-specific, non-portable, but it allows you to create a policy object in a single line of code, rather than going via the ORB and stuffing the timeout value into an Any.

Parameters: relative_expiry the duration of this timeout, in CORBA time units (100 nanosecond resolution). If you have a value in milliseconds, multiply that by 10,000.

Method Detail

copy

public Policy copy()

destroy

public void destroy()

policy_type

public int policy_type()

relative_expiry

public long relative_expiry()
Returns the duration of this timeout, in CORBA time units (100 nanosecond resolution). To convert it to milliseconds, divide by 10,000.