TAO_ORB_Parameters Class Reference

Parameters that are specific to the ORB. These parameters can be for the client, the server, or for both. More...

#include <params.h>

Collaboration diagram for TAO_ORB_Parameters:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ACE_Array_Map< ACE_CString,
ACE_CString
endpoints_map_type

Public Member Functions

 TAO_ORB_Parameters (void)
 Constructor.
int add_endpoints (const ACE_CString &lane, const ACE_CString &endpoints)
void get_endpoint_set (const ACE_CString &lane, TAO_EndpointSet &endpoint_set)
CORBA::UShort service_port (TAO::MCAST_SERVICEID service_id) const
 Set/Get the port of services locatable through multicast.
void service_port (TAO::MCAST_SERVICEID service_id, CORBA::UShort port)
const char * mcast_discovery_endpoint (void) const
void mcast_discovery_endpoint (const char *mde)
int sock_rcvbuf_size (void) const
 Set/Get the size to be used for a socket's receive buffer.
void sock_rcvbuf_size (int)
int sock_sndbuf_size (void) const
 Set/Get the size to be used for a socket's send buffer.
void sock_sndbuf_size (int)
int nodelay (void) const
 Set/Get the status of whether to use TCP_NODELAY or not.
void nodelay (int)
int sock_keepalive (void)
 Set/Get whether we should set SO_KEEPALIVE on the socket or not.
void sock_keepalive (int)
int cdr_memcpy_tradeoff (void) const
void cdr_memcpy_tradeoff (int)
int use_dotted_decimal_addresses (void) const
void use_dotted_decimal_addresses (int)
int cache_incoming_by_dotted_decimal_address (void) const
void cache_incoming_by_dotted_decimal_address (int)
int linger (void) const
 The ORB will turn off SO_LINGER if this is zero.
void linger (int)
char * default_init_ref (void) const
 Set/Get the Init Reference of an arbitrary ObjectID.
void default_init_ref (const char *default_init_ref)
int std_profile_components (void) const
void std_profile_components (int x)
int ace_sched_policy (void) const
 Scheduling policy.
void ace_sched_policy (int x)
long sched_policy (void) const
 Scheduling policy flag.
void sched_policy (long x)
long scope_policy (void) const
 Scheduling scope flag.
void scope_policy (long x)
long thread_creation_flags (void) const
 Thread creation flags.
int single_read_optimization (void) const
 Single read optimization.
void single_read_optimization (int x)
int shared_profile (void) const
 Create shared profiles without priority.
void shared_profile (int x)
bool disable_rt_collocation_resolver (void) const
 Mutators and accessors for rt_collocation_resolver.
void disable_rt_collocation_resolver (bool)
bool preferred_interfaces (const char *s)
const char * preferred_interfaces (void) const
void enforce_pref_interfaces (bool p)
bool enforce_pref_interfaces (void) const
void prefer_ipv6_interfaces (bool p)
bool prefer_ipv6_interfaces (void) const
void connect_ipv6_only (bool p)
bool connect_ipv6_only (void) const
void negotiate_codesets (bool c)
bool negotiate_codesets (void) const

Private Member Functions

int parse_and_add_endpoints (const ACE_CString &endpoints, TAO_EndpointSet &endpoint_set)

Private Attributes

endpoints_map_type endpoints_map_
 Map of endpoints this server is willing to accept requests on.
CORBA::UShort service_port_ [TAO_NO_OF_MCAST_SERVICES]
 Port numbers of the configured services.
CORBA::String_var mcast_discovery_endpoint_
ACE_CString default_init_ref_
 List of comma separated prefixes from ORBDefaultInitRef.
int sock_rcvbuf_size_
 Size to be used for a socket's receive buffer.
int sock_sndbuf_size_
 Size to be used for a socket's send buffer.
int nodelay_
 1 if we're using TCP_NODELAY and 0 otherwise.
int sock_keepalive_
 1 if we're using SO_KEEPALIV and 0 otherwise (default 0).
int cdr_memcpy_tradeoff_
int use_lite_protocol_
 For selecting a liteweight version of the GIOP protocol.
int use_dotted_decimal_addresses_
 For selecting a address notation.
int cache_incoming_by_dotted_decimal_address_
int linger_
 For setting the SO_LINGER option.
int std_profile_components_
 If true then the standard OMG components are not generated.
int ace_sched_policy_
 Scheduling policy.
long sched_policy_
 Scheduling policy flag.
long scope_policy_
 Scheduling scope flag.
int single_read_optimization_
 Single read optimization.
int shared_profile_
 Shared Profile - Use the same profile for multiple endpoints.
ACE_CString pref_network_
 Preferred network interfaces as a string.
bool disable_rt_collocation_resolver_
 Default collocation resolver.
bool enforce_preferred_interfaces_
bool prefer_ipv6_interfaces_
 Prefer to connect IPv6 over IPv4 Yes or No.
bool connect_ipv6_only_
bool negotiate_codesets_
 Enable the use of codeset negotiation.

Detailed Description

Parameters that are specific to the ORB. These parameters can be for the client, the server, or for both.


Member Typedef Documentation

typedef ACE_Array_Map<ACE_CString, ACE_CString> TAO_ORB_Parameters::endpoints_map_type


Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_ORB_Parameters::TAO_ORB_Parameters ( void   ) 

Constructor.


Member Function Documentation

ACE_INLINE void TAO_ORB_Parameters::ace_sched_policy ( int  x  ) 

ACE_INLINE int TAO_ORB_Parameters::ace_sched_policy ( void   )  const

Scheduling policy.

Scheduling policy specified by the user through the -ORBSchedPolicy option. This value is typically used by functions like ACE_OS::thr_setprio() and ACE_Sched_Params::priority_min(). Legal values are ACE_SCHED_RR, ACE_SCHED_FIFO, and ACE_SCHED_OTHER.

int TAO_ORB_Parameters::add_endpoints ( const ACE_CString lane,
const ACE_CString endpoints 
)

Specifies the endpoints on which this server is willing to listen for requests.

ACE_INLINE void TAO_ORB_Parameters::cache_incoming_by_dotted_decimal_address ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::cache_incoming_by_dotted_decimal_address ( void   )  const

The ORB will cache incoming connections against the dotted decimal form of the peer's address

ACE_INLINE void TAO_ORB_Parameters::cdr_memcpy_tradeoff ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::cdr_memcpy_tradeoff ( void   )  const

Octet sequences are marshalled without doing any copies, we simply append a block to the CDR message block chain. When the octet sequence is small enough and there is room in the current message block it is more efficient just to copy the buffer.

bool TAO_ORB_Parameters::connect_ipv6_only ( void   )  const

void TAO_ORB_Parameters::connect_ipv6_only ( bool  p  ) 

ACE_INLINE void TAO_ORB_Parameters::default_init_ref ( const char *  default_init_ref  ) 

ACE_INLINE char * TAO_ORB_Parameters::default_init_ref ( void   )  const

Set/Get the Init Reference of an arbitrary ObjectID.

ACE_INLINE void TAO_ORB_Parameters::disable_rt_collocation_resolver ( bool   ) 

ACE_INLINE bool TAO_ORB_Parameters::disable_rt_collocation_resolver ( void   )  const

Mutators and accessors for rt_collocation_resolver.

bool TAO_ORB_Parameters::enforce_pref_interfaces ( void   )  const

void TAO_ORB_Parameters::enforce_pref_interfaces ( bool  p  ) 

void TAO_ORB_Parameters::get_endpoint_set ( const ACE_CString lane,
TAO_EndpointSet endpoint_set 
)

ACE_INLINE void TAO_ORB_Parameters::linger ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::linger ( void   )  const

The ORB will turn off SO_LINGER if this is zero.

ACE_INLINE void TAO_ORB_Parameters::mcast_discovery_endpoint ( const char *  mde  ) 

ACE_INLINE const char * TAO_ORB_Parameters::mcast_discovery_endpoint ( void   )  const

Get/Set address:port for Multicast Discovery Protocol for the Naming Service.

ACE_INLINE bool TAO_ORB_Parameters::negotiate_codesets ( void   )  const

ACE_INLINE void TAO_ORB_Parameters::negotiate_codesets ( bool  c  ) 

ACE_INLINE void TAO_ORB_Parameters::nodelay ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::nodelay ( void   )  const

Set/Get the status of whether to use TCP_NODELAY or not.

int TAO_ORB_Parameters::parse_and_add_endpoints ( const ACE_CString endpoints,
TAO_EndpointSet endpoint_set 
) [private]

bool TAO_ORB_Parameters::prefer_ipv6_interfaces ( void   )  const

void TAO_ORB_Parameters::prefer_ipv6_interfaces ( bool  p  ) 

const char * TAO_ORB_Parameters::preferred_interfaces ( void   )  const

bool TAO_ORB_Parameters::preferred_interfaces ( const char *  s  ) 

Accepts the list of preferred interfaces and does a simple semantic check on the string

ACE_INLINE void TAO_ORB_Parameters::sched_policy ( long  x  ) 

ACE_INLINE long TAO_ORB_Parameters::sched_policy ( void   )  const

Scheduling policy flag.

Scheduling policy specified by the user through the -ORBSchedPolicy option. This value is typically used by ACE thread creation functions. Legal values are THR_SCHED_RR, THR_SCHED_FIFO, and THR_SCHED_DEFAULT.

ACE_INLINE void TAO_ORB_Parameters::scope_policy ( long  x  ) 

ACE_INLINE long TAO_ORB_Parameters::scope_policy ( void   )  const

Scheduling scope flag.

Scheduling policy specified by the user through the -ORBScopePolicy option. This value is typically used by ACE thread creation functions. Legal values are THR_SCOPE_SYSTEM and THR_SCOPE_PROCESS.

ACE_INLINE void TAO_ORB_Parameters::service_port ( TAO::MCAST_SERVICEID  service_id,
CORBA::UShort  port 
)

ACE_INLINE CORBA::UShort TAO_ORB_Parameters::service_port ( TAO::MCAST_SERVICEID  service_id  )  const

Set/Get the port of services locatable through multicast.

ACE_INLINE void TAO_ORB_Parameters::shared_profile ( int  x  ) 

ACE_INLINE int TAO_ORB_Parameters::shared_profile ( void   )  const

Create shared profiles without priority.

ACE_INLINE void TAO_ORB_Parameters::single_read_optimization ( int  x  ) 

ACE_INLINE int TAO_ORB_Parameters::single_read_optimization ( void   )  const

Single read optimization.

ACE_INLINE void TAO_ORB_Parameters::sock_keepalive ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::sock_keepalive ( void   ) 

Set/Get whether we should set SO_KEEPALIVE on the socket or not.

ACE_INLINE void TAO_ORB_Parameters::sock_rcvbuf_size ( int   ) 

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE int TAO_ORB_Parameters::sock_rcvbuf_size ( void   )  const

Set/Get the size to be used for a socket's receive buffer.

ACE_INLINE void TAO_ORB_Parameters::sock_sndbuf_size ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::sock_sndbuf_size ( void   )  const

Set/Get the size to be used for a socket's send buffer.

ACE_INLINE void TAO_ORB_Parameters::std_profile_components ( int  x  ) 

ACE_INLINE int TAO_ORB_Parameters::std_profile_components ( void   )  const

Disable the OMG standard profile components, useful for homogenous environments.

ACE_INLINE long TAO_ORB_Parameters::thread_creation_flags ( void   )  const

Thread creation flags.

Shorthand for OR'ing together the scope_policy and sched_policy.

ACE_INLINE void TAO_ORB_Parameters::use_dotted_decimal_addresses ( int   ) 

ACE_INLINE int TAO_ORB_Parameters::use_dotted_decimal_addresses ( void   )  const

The ORB will use the dotted decimal notation for addresses. By default we use the full ascii names.


Member Data Documentation

int TAO_ORB_Parameters::ace_sched_policy_ [private]

Scheduling policy.

Scheduling policy specified by the user through the -ORBSchedPolicy option. This value is typically used by functions like ACE_OS::thr_setprio() and ACE_Sched_Params::priority_min(). Legal values are ACE_SCHED_RR, ACE_SCHED_FIFO, and ACE_SCHED_OTHER.

int TAO_ORB_Parameters::cache_incoming_by_dotted_decimal_address_ [private]

If incoming connections should be cached against IP (true) or hostname (false).

int TAO_ORB_Parameters::cdr_memcpy_tradeoff_ [private]

Control the strategy for copying vs. appeding octet sequences in CDR streams.

bool TAO_ORB_Parameters::connect_ipv6_only_ [private]

Only connect to (client) or listen on and accept from (server) IPv6 interfaces Yes or No.

ACE_CString TAO_ORB_Parameters::default_init_ref_ [private]

List of comma separated prefixes from ORBDefaultInitRef.

bool TAO_ORB_Parameters::disable_rt_collocation_resolver_ [private]

Default collocation resolver.

The vanilla ORB has only one collocation resolver. But if the RTORB is in place, the RTORB can get in a new collocation resolver. There are some applications that would like to use the default collocation resolver with the RTORB. This boolean is the value of the option that the application passes in to enable/disable the use of RT collocation resolver with the RTORB. The default value is false to indicate that the RT_Collocation_Resolver will be loaded if the RTORB is used.

endpoints_map_type TAO_ORB_Parameters::endpoints_map_ [private]

Map of endpoints this server is willing to accept requests on.

bool TAO_ORB_Parameters::enforce_preferred_interfaces_ [private]

int TAO_ORB_Parameters::linger_ [private]

For setting the SO_LINGER option.

CORBA::String_var TAO_ORB_Parameters::mcast_discovery_endpoint_ [private]

Address:port for Multicast Discovery Protocol for the Naming Service.

bool TAO_ORB_Parameters::negotiate_codesets_ [private]

Enable the use of codeset negotiation.

int TAO_ORB_Parameters::nodelay_ [private]

1 if we're using TCP_NODELAY and 0 otherwise.

ACE_CString TAO_ORB_Parameters::pref_network_ [private]

Preferred network interfaces as a string.

bool TAO_ORB_Parameters::prefer_ipv6_interfaces_ [private]

Prefer to connect IPv6 over IPv4 Yes or No.

long TAO_ORB_Parameters::sched_policy_ [private]

Scheduling policy flag.

Scheduling policy specified by the user through the -ORBSchedPolicy option. This value is typically used by ACE thread creation functions. Legal values are THR_SCHED_RR, THR_SCHED_FIFO, and THR_SCHED_DEFAULT.

long TAO_ORB_Parameters::scope_policy_ [private]

Scheduling scope flag.

Scheduling policy specified by the user through the -ORBScopePolicy option. This value is typically used by ACE thread creation functions. Legal values are THR_SCOPE_SYSTEM and THR_SCOPE_PROCESS.

CORBA::UShort TAO_ORB_Parameters::service_port_[TAO_NO_OF_MCAST_SERVICES] [private]

Port numbers of the configured services.

int TAO_ORB_Parameters::shared_profile_ [private]

Shared Profile - Use the same profile for multiple endpoints.

int TAO_ORB_Parameters::single_read_optimization_ [private]

Single read optimization.

int TAO_ORB_Parameters::sock_keepalive_ [private]

1 if we're using SO_KEEPALIV and 0 otherwise (default 0).

int TAO_ORB_Parameters::sock_rcvbuf_size_ [private]

Size to be used for a socket's receive buffer.

int TAO_ORB_Parameters::sock_sndbuf_size_ [private]

Size to be used for a socket's send buffer.

int TAO_ORB_Parameters::std_profile_components_ [private]

If true then the standard OMG components are not generated.

int TAO_ORB_Parameters::use_dotted_decimal_addresses_ [private]

For selecting a address notation.

int TAO_ORB_Parameters::use_lite_protocol_ [private]

For selecting a liteweight version of the GIOP protocol.


The documentation for this class was generated from the following files:
Generated on Wed Apr 19 03:25:12 2006 for TAO by  doxygen 1.4.6-4