#include <Connection_Handler.h>

Inheritance diagram for TAO_Connection_Handler:

[legend]

Collaboration diagram for TAO_Connection_Handler:

[legend]

Public Member Functions
	TAO_Connection_Handler (TAO_ORB_Core *orb_core)
	Constructor. More...

virtual	~TAO_Connection_Handler (void)
	Destructor. More...

TAO_Transport *	transport (void)
	Return the underlying transport object. More...

void	transport (TAO_Transport *transport)
	Set the underlying transport object. More...

bool	is_closed () const
	Is the handler closed or timed out? More...

bool	is_open () const
	Is the handler open? More...

bool	is_timeout () const
	Closed due to timeout? More...

bool	is_connecting () const
	Is the handler in the process of being connected? More...

virtual int	close_connection (void)=0
	Close the underlying connection. More...

virtual int	handle_input (ACE_HANDLE fd)=0

int	svc_i (void)

virtual int	open_handler (void *)=0
	A open () hook. More...

virtual int	close_handler (u_long flags=0)

void	connection_pending (void)

void	cancel_pending_connection (void)

virtual int	set_dscp_codepoint (CORBA::Boolean set_network_priority)

virtual int	set_dscp_codepoint (CORBA::Long dscp_codepoint)

virtual int	release_os_resources (void)
	Release the OS resources related to this handler. More...

virtual int	handle_write_ready (const ACE_Time_Value *timeout)

Public Member Functions inherited from TAO_LF_CH_Event
	TAO_LF_CH_Event (void)
	Constructor. More...

virtual	~TAO_LF_CH_Event (void)
	Destructor. More...

Public Member Functions inherited from TAO_LF_Event
	TAO_LF_Event (void)
	Constructor. More...

virtual	~TAO_LF_Event (void)
	Destructor. More...

void	state_changed (LFS_STATE new_state, TAO_Leader_Follower &lf)

bool	successful (TAO_Leader_Follower &lf) const

bool	error_detected (TAO_Leader_Follower &lf) const

bool	keep_waiting (TAO_Leader_Follower &lf) const
	Check if we should keep waiting. More...

void	reset_state (LFS_STATE new_state)
	Reset the state, irrespective of the previous states. More...

Protected Member Functions
TAO_ORB_Core *	orb_core (void)
	Return our TAO_ORB_Core pointer. More...

int	shared_open (void)

int	set_socket_option (ACE_SOCK &sock, int snd_size, int rcv_size)
	Set options on the socket. More...

Protected Member Functions inherited from TAO_LF_CH_Event
virtual bool	is_state_final () const
	Check whether we have reached the final state.. More...

Protected Member Functions inherited from TAO_LF_Event
bool	keep_waiting_i () const
	Check if we should keep waiting. More...

Helper methods for Event_Handler-based derived classes.
Many (actually all so far) implementations of TAO_Connection_Handler are a mixin of TAO_Connection_Handler and some form of ACE_Event_Handler. The following methods simplify such implementations by capturing the common code in a single place.
TAO_ORB_Core *const	orb_core_
	Pointer to the TAO_ORB_Core. More...

TAO_Transport *	transport_
	Transport object reference. More...

bool	connection_pending_
	Stores the connection pending state. More...

bool	is_closed_

int	handle_output_eh (ACE_HANDLE h, ACE_Event_Handler *eh)
	Implement the handle_output() callback. More...

int	handle_input_eh (ACE_HANDLE h, ACE_Event_Handler *eh)
	Implement the handle_input() callback. More...

int	handle_input_internal (ACE_HANDLE h, ACE_Event_Handler *eh)
	Pointer to the TAO_ORB_Core. More...

int	close_connection_eh (ACE_Event_Handler *eh)

virtual void	pre_io_hook (int &return_value)

virtual void	pos_io_hook (int &return_value)

	TAO_Connection_Handler (const TAO_Connection_Handler &)=delete
	Pointer to the TAO_ORB_Core. More...

TAO_Connection_Handler &	operator= (const TAO_Connection_Handler &)=delete
	Pointer to the TAO_ORB_Core. More...

Additional Inherited Members
Public Types inherited from TAO_LF_Event
enum	LFS_STATE { LFS_IDLE = 0 , LFS_ACTIVE , LFS_CONNECTION_WAIT , LFS_SUCCESS , LFS_FAILURE , LFS_TIMEOUT , LFS_CONNECTION_CLOSED }
	The current state. More...

Static Public Member Functions inherited from TAO_LF_Event
static const char *	state_name (LFS_STATE st)
	The current state. More...

Protected Attributes inherited from TAO_LF_Event
LFS_STATE	state_
	The current state. More...

TAO_LF_Follower *	follower_
	The bounded follower. More...

Detailed Description

TAO_Connection_Handler.

This class is an abstraction for the connection handlers. The connections handler in every protocol can derive from this class as well as the ACE_Svc_Handler specialised for the right protocol. This way, most of the common code for the different protocols would be in this implementation.

Constructor & Destructor Documentation

◆ TAO_Connection_Handler() [1/2]

TAO_Connection_Handler::TAO_Connection_Handler ( TAO_ORB_Core * orb_core )

explicit

Constructor.

◆ ~TAO_Connection_Handler()

TAO_Connection_Handler::~TAO_Connection_Handler ( void )

virtual

Destructor.

◆ TAO_Connection_Handler() [2/2]

TAO_Connection_Handler::TAO_Connection_Handler ( const TAO_Connection_Handler & )

privatedelete

Pointer to the TAO_ORB_Core.

Member Function Documentation

◆ cancel_pending_connection()

void TAO_Connection_Handler::cancel_pending_connection ( void )

A pending connection may be canceled due to an error detected while the initiating thread is still in the Connector.

◆ close_connection()

virtual int TAO_Connection_Handler::close_connection ( void )

pure virtual

Close the underlying connection.

Used by the ORB to actively close connections that are idle, stale or somehow are determined to be broken before the Reactor does.

Returns: Return 0 if the connection was already closed, non-zero otherwise.

Implemented in TAO_IIOP_Connection_Handler.

◆ close_connection_eh()

int TAO_Connection_Handler::close_connection_eh ( ACE_Event_Handler * eh )

protected

Implement close_connection() for Connection_Handlers that are also Event_Handlers.

◆ close_handler()

int TAO_Connection_Handler::close_handler ( u_long flags = 0 )

virtual

A close() hook, called by the Transport Connector when they want to close this handler

◆ connection_pending()

void TAO_Connection_Handler::connection_pending ( void )

When waiting for an asynchronous connection to complete an additional reference must be maintained, related to bugzilla #2417. However once the connection is successfully established, this reference must be removed. Using connection_pending allows the connection handler to know that it is opening as a result of a delayed asynch connection rather than an immediate synch connection, which has no additional reference needs.

◆ handle_input()

virtual int TAO_Connection_Handler::handle_input ( ACE_HANDLE fd )

pure virtual

The event handler calls, here so that other objects who hold a reference to this object can call the event handler methods.

Implemented in TAO_IIOP_Connection_Handler.

◆ handle_input_eh()

int TAO_Connection_Handler::handle_input_eh	(	ACE_HANDLE	h,
		ACE_Event_Handler *	eh
	)

protected

Implement the handle_input() callback.

◆ handle_input_internal()

int TAO_Connection_Handler::handle_input_internal	(	ACE_HANDLE	h,
		ACE_Event_Handler *	eh
	)

protected

Pointer to the TAO_ORB_Core.

◆ handle_output_eh()

int TAO_Connection_Handler::handle_output_eh	(	ACE_HANDLE	h,
		ACE_Event_Handler *	eh
	)

protected

Implement the handle_output() callback.

◆ handle_write_ready()

int TAO_Connection_Handler::handle_write_ready ( const ACE_Time_Value * timeout )

virtual

Derived classes should implement this for proper support with the Blocking Flushing Strategy.

Reimplemented in TAO_IIOP_Connection_Handler.

◆ is_closed()

bool TAO_Connection_Handler::is_closed ( ) const

Is the handler closed or timed out?

◆ is_connecting()

bool TAO_Connection_Handler::is_connecting ( ) const

Is the handler in the process of being connected?

◆ is_open()

bool TAO_Connection_Handler::is_open ( ) const

Is the handler open?

◆ is_timeout()

bool TAO_Connection_Handler::is_timeout ( ) const

Closed due to timeout?

◆ open_handler()

virtual int TAO_Connection_Handler::open_handler ( void * )

pure virtual

A open () hook.

See Thread_Per_Connection_Handler for a use case

Implemented in TAO_IIOP_Connection_Handler.

◆ operator=()

TAO_Connection_Handler & TAO_Connection_Handler::operator= ( const TAO_Connection_Handler & )

privatedelete

Pointer to the TAO_ORB_Core.

◆ orb_core()

TAO_ORB_Core * TAO_Connection_Handler::orb_core ( void )

protected

Return our TAO_ORB_Core pointer.

◆ pos_io_hook()

void TAO_Connection_Handler::pos_io_hook ( int & return_value )

protectedvirtual

Post-invocation hook for I/O operations (handle_input() & handle_output()) See the SSLIOP protocol for an interesting use-case

◆ pre_io_hook()

void TAO_Connection_Handler::pre_io_hook ( int & return_value )

protectedvirtual

Pre-invocation hook for I/O operations (handle_input() & handle_output()) See the SSLIOP protocol for an interesting use-case

◆ release_os_resources()

int TAO_Connection_Handler::release_os_resources ( void )

virtual

Release the OS resources related to this handler.

Reimplemented in TAO_IIOP_Connection_Handler.

◆ set_dscp_codepoint() [1/2]

int TAO_Connection_Handler::set_dscp_codepoint ( CORBA::Boolean set_network_priority )

virtual

Set the Diff-Serv codepoint on outgoing packets. Only has effect for remote protocols (e.g., IIOP); no effect for local protocols (UIOP). Default implementation is for local protocols. Remote protocols must overwrite implementation.

Reimplemented in TAO_IIOP_Connection_Handler.

◆ set_dscp_codepoint() [2/2]

int TAO_Connection_Handler::set_dscp_codepoint ( CORBA::Long dscp_codepoint )

virtual

Reimplemented in TAO_IIOP_Connection_Handler.

◆ set_socket_option()

int TAO_Connection_Handler::set_socket_option	(	ACE_SOCK &	sock,
		int	snd_size,
		int	rcv_size
	)

protected

Set options on the socket.

◆ shared_open()

int TAO_Connection_Handler::shared_open ( void )

protected

A common function called at the start of any protocol-specific open. Returns -1 on a failure (although no failure mode is currently defined).

◆ svc_i()

int TAO_Connection_Handler::svc_i ( void )

This method is invoked from the svc () method of the Svc_Handler Object.

◆ transport() [1/2]

void TAO_Connection_Handler::transport ( TAO_Transport * transport )

Set the underlying transport object.

◆ transport() [2/2]

TAO_Transport * TAO_Connection_Handler::transport ( void )

Return the underlying transport object.

Member Data Documentation

◆ connection_pending_

bool TAO_Connection_Handler::connection_pending_

private

Stores the connection pending state.

◆ is_closed_

bool TAO_Connection_Handler::is_closed_

private

Once closed make sure the transport is not added back to the cache. This is distinct from the leader-follower state so it cannot be reset.

◆ orb_core_

TAO_ORB_Core* const TAO_Connection_Handler::orb_core_

private

Pointer to the TAO_ORB_Core.

◆ transport_

TAO_Transport* TAO_Connection_Handler::transport_

private

Transport object reference.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Helper methods for Event_Handler-based derived classes.

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TAO_Connection_Handler() [1/2]

◆ ~TAO_Connection_Handler()

◆ TAO_Connection_Handler() [2/2]

Member Function Documentation

◆ cancel_pending_connection()

◆ close_connection()

◆ close_connection_eh()

◆ close_handler()

◆ connection_pending()

◆ handle_input()

◆ handle_input_eh()

◆ handle_input_internal()

◆ handle_output_eh()

◆ handle_write_ready()

◆ is_closed()

◆ is_connecting()

◆ is_open()

◆ is_timeout()

◆ open_handler()

◆ operator=()

◆ orb_core()

◆ pos_io_hook()

◆ pre_io_hook()

◆ release_os_resources()

◆ set_dscp_codepoint() [1/2]

◆ set_dscp_codepoint() [2/2]

◆ set_socket_option()

◆ shared_open()

◆ svc_i()

◆ transport() [1/2]

◆ transport() [2/2]

Member Data Documentation

◆ connection_pending_

◆ is_closed_

◆ orb_core_

◆ transport_