org.jacorb.orb.policies
Class RelativeRequestTimeoutPolicy

java.lang.Object
  extended by org.omg.CORBA.LocalObject
      extended by org.omg.Messaging._RelativeRequestTimeoutPolicyLocalBase
          extended by org.jacorb.orb.policies.RelativeRequestTimeoutPolicy
All Implemented Interfaces:
java.io.Serializable, LocalInterface, Object, Policy, PolicyOperations, IDLEntity, RelativeRequestTimeoutPolicy, RelativeRequestTimeoutPolicyOperations

public class RelativeRequestTimeoutPolicy
extends _RelativeRequestTimeoutPolicyLocalBase

Specifies a relative timeout for a CORBA request. It is an upper bound for the time it may take for a request to get from the client to the server. The timeout does not include the time needed for getting the reply back to the client.

Version:
$Id: RelativeRequestTimeoutPolicy.java,v 1.8 2008-11-14 08:55:33 nick.cross Exp $
Author:
Andre Spiegel spiegel@gnu.org
See Also:
Serialized Form

Constructor Summary
RelativeRequestTimeoutPolicy(Any value)
          Constructs a new RelativeRequestTimeoutPolicy object from an Any value.
RelativeRequestTimeoutPolicy(long relative_expiry)
          Convenience constructor for RelativeRequestTimeoutPolicy.
 
Method Summary
 Policy copy()
           
 void destroy()
           
 int policy_type()
           
 long relative_expiry()
          Returns the duration of this timeout, in CORBA time units (100 nanosecond resolution).
 
Methods inherited from class org.omg.Messaging._RelativeRequestTimeoutPolicyLocalBase
_ids
 
Methods inherited from class org.omg.CORBA.LocalObject
_create_request, _create_request, _duplicate, _get_component, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_policy_override, validate_connection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.omg.CORBA.Object
_create_request, _create_request, _duplicate, _get_component, _get_domain_managers, _get_interface_def, _get_interface, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override
 

Constructor Detail

RelativeRequestTimeoutPolicy

public RelativeRequestTimeoutPolicy(Any value)
Constructs a new RelativeRequestTimeoutPolicy 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.

RelativeRequestTimeoutPolicy

public RelativeRequestTimeoutPolicy(long relative_expiry)
Convenience constructor for RelativeRequestTimeoutPolicy. 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

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.


policy_type

public int policy_type()

copy

public Policy copy()

destroy

public void destroy()