TAO_Transport Class Reference

Generic definitions for the Transport class. More...

#include <Transport.h>

Inheritance diagram for TAO_Transport:

[legend]Collaboration diagram for TAO_Transport:

[legend]List of all members.

Template methods
The Transport class uses the Template Method Pattern to implement the protocol specific functionality. Implementors of a pluggable protocol should override the following methods with the semantics documented below.
enum	{ TAO_ONEWAY_REQUEST = 0, TAO_TWOWAY_REQUEST = 1, TAO_REPLY }
virtual ACE_Event_Handler *	event_handler_i (void)=0
bool	is_connected (void) const
	Is this transport really connected.
bool	post_open (size_t id)
	Perform all the actions when this transport get opened.
TAO_Connection_Handler *	connection_handler (void)
	Get the connection handler for this transport.
TAO_OutputCDR &	out_stream (void)
	Accessor for the output CDR stream.
int	generate_locate_request (TAO_Target_Specification &spec, TAO_Operation_Details &opdetails, TAO_OutputCDR &output)
virtual int	generate_request_header (TAO_Operation_Details &opd, TAO_Target_Specification &spec, TAO_OutputCDR &msg)
int	recache_transport (TAO_Transport_Descriptor_Interface *desc)
	Recache ourselves in the cache.
virtual int	handle_input (TAO_Resume_Handle &rh, ACE_Time_Value *max_wait_time=0, int block=0)
	Callback to read incoming data.
virtual int	send_request (TAO_Stub *stub, TAO_ORB_Core *orb_core, TAO_OutputCDR &stream, int message_semantics, ACE_Time_Value *max_time_wait)=0
virtual int	send_message (TAO_OutputCDR &stream, TAO_Stub *stub=0, int message_semantics=TAO_Transport::TAO_TWOWAY_REQUEST, ACE_Time_Value *max_time_wait=0)=0
virtual int	send_message_shared (TAO_Stub *stub, int message_semantics, const ACE_Message_Block *message_block, ACE_Time_Value *max_wait_time)
	Sent the contents of message_block.
int	format_queue_message (TAO_OutputCDR &stream)
	Format and queue a message for stream.
int	send_message_block_chain (const ACE_Message_Block *message_block, size_t &bytes_transferred, ACE_Time_Value *max_wait_time=0)
	Send a message block chain,.
int	send_message_block_chain_i (const ACE_Message_Block *message_block, size_t &bytes_transferred, ACE_Time_Value *max_wait_time)
	Send a message block chain, assuming the lock is held.
int	purge_entry (void)
	Cache management.
int	make_idle (void)
	Cache management.
int	update_transport (void)
	Cache management.
int	handle_timeout (const ACE_Time_Value &current_time, const void *act)
size_t	recv_buffer_size (void) const
	Accessor to recv_buffer_size_.
size_t	sent_byte_count (void) const
	Accessor to sent_byte_count_.
TAO_Codeset_Translator_Base *	char_translator (void) const
	CodeSet Negotiation - Get the char codeset translator factory.
TAO_Codeset_Translator_Base *	wchar_translator (void) const
	CodeSet Negotiation - Get the wchar codeset translator factory.
void	char_translator (TAO_Codeset_Translator_Base *)
	CodeSet negotiation - Set the char codeset translator factory.
void	wchar_translator (TAO_Codeset_Translator_Base *)
	CodeSet negotiation - Set the wchar codeset translator factory.
void	assign_translators (TAO_InputCDR *, TAO_OutputCDR *)
void	clear_translators (TAO_InputCDR *, TAO_OutputCDR *)
CORBA::Boolean	is_tcs_set () const
	Return true if the tcs has been set.
void	first_request_sent ()
	Set the state of the first_request_ flag to 0.
void	send_connection_closed_notifications (void)
virtual TAO_Connection_Handler *	connection_handler_i (void)=0
int	process_parsed_messages (TAO_Queued_Data *qd, TAO_Resume_Handle &rh)
int	send_message_shared_i (TAO_Stub *stub, int message_semantics, const ACE_Message_Block *message_block, ACE_Time_Value *max_wait_time)
int	queue_message_i (const ACE_Message_Block *message_block)
	Queue a message for message_block.
CORBA::ULong const	tag_
	IOP protocol tag.
TAO_ORB_Core *const	orb_core_
	Global orbcore resource.
TAO::Transport_Cache_Manager::HASH_MAP_ENTRY *	cache_map_entry_
TAO_Transport_Mux_Strategy *	tms_
TAO_Wait_Strategy *	ws_
	Strategy for waiting for the reply after sending the request.
int	bidirectional_flag_
TAO::Connection_Role	opening_connection_role_
TAO_Queued_Message *	head_
	Implement the outgoing data queue.
TAO_Queued_Message *	tail_
TAO_Incoming_Message_Queue	incoming_message_queue_
	Queue of the consolidated, incoming messages..
TAO::Incoming_Message_Stack	incoming_message_stack_
ACE_Time_Value	current_deadline_
long	flush_timer_id_
	The timer ID.
TAO_Transport_Timer	transport_timer_
	The adapter used to receive timeout callbacks from the Reactor.
ACE_Lock *	handler_lock_
size_t	id_
	A unique identifier for the transport.
unsigned long	purging_order_
	Used by the LRU, LFU and FIFO Connection Purging Strategies.
size_t	recv_buffer_size_
	Size of the buffer received.
size_t	sent_byte_count_
	Number of bytes sent.
bool	is_connected_
TAO::Transport_Cache_Manager &	transport_cache_manager (void)
	Helper method that returns the Transport Cache Manager.
int	drain_queue (void)
	Send some of the data in the queue.
int	drain_queue_i (void)
	Implement drain_queue() assuming the lock is held.
int	queue_is_empty_i (void)
	Check if there are messages pending in the queue.
int	drain_queue_helper (int &iovcnt, iovec iov[])
	A helper routine used in drain_queue_i().
int	schedule_output_i (void)
	Schedule handle_output() callbacks.
int	cancel_output_i (void)
	Cancel handle_output() callbacks.
void	cleanup_queue (size_t byte_count)
	Cleanup the queue.
void	cleanup_queue_i ()
	Cleanup the complete queue.
int	check_buffering_constraints_i (TAO_Stub *stub, bool &must_flush)
	Check if the buffering constraints have been reached.
int	send_synchronous_message_i (const ACE_Message_Block *message_block, ACE_Time_Value *max_wait_time)
int	send_reply_message_i (const ACE_Message_Block *message_block, ACE_Time_Value *max_wait_time)
int	send_asynchronous_message_i (TAO_Stub *stub, const ACE_Message_Block *message_block, ACE_Time_Value *max_wait_time)
int	send_synch_message_helper_i (TAO_Synch_Queued_Message &s, ACE_Time_Value *max_wait_time)
int	flush_timer_pending (void) const
	Check if the flush timer is still pending.
void	reset_flush_timer (void)
void	report_invalid_event_handler (const char *caller)
	Print out error messages if the event handler is not valid.
int	handle_input_missing_data (TAO_Resume_Handle &rh, ACE_Time_Value *max_wait_time, TAO_Queued_Data *q_data)
int	handle_input_parse_data (TAO_Resume_Handle &rh, ACE_Time_Value *max_wait_time)
int	handle_input_parse_extra_messages (ACE_Message_Block &message_block)
int	consolidate_enqueue_message (TAO_Queued_Data *qd)
	-1 error, otherwise 0
int	consolidate_process_message (TAO_Queued_Data *qd, TAO_Resume_Handle &rh)
	-1 error, otherwise 0
int	process_queue_head (TAO_Resume_Handle &rh)
int	notify_reactor (void)
void	send_connection_closed_notifications_i (void)
	Assume the lock is held.
void	allocate_partial_message_block (void)
	TAO_Transport (const TAO_Transport &)
void	operator= (const TAO_Transport &)
TAO_Codeset_Translator_Base *	char_translator_
	Additional member values required to support codeset translation.
TAO_Codeset_Translator_Base *	wchar_translator_
CORBA::Boolean	tcs_set_
CORBA::Boolean	first_request_
ACE_Message_Block *	partial_message_
	Holds the partial GIOP message (if there is one).
class	TAO_Block_Flushing_Strategy
class	TAO_Reactive_Flushing_Strategy
class	TAO_Leader_Follower_Flushing_Strategy
class	TAO_Thread_Per_Connection_Handler
Public Types
Public Member Functions
	TAO_Transport (CORBA::ULong tag, TAO_ORB_Core *orb_core)
	Default creator, requires the tag value be supplied.
virtual	~TAO_Transport (void)
	Destructor.
CORBA::ULong	tag (void) const
	Return the protocol tag.
TAO_ORB_Core *	orb_core (void) const
	Access the ORB that owns this connection.
TAO_Transport_Mux_Strategy *	tms (void) const
	Get the TAO_Tranport_Mux_Strategy used by this object.
TAO_Wait_Strategy *	wait_strategy (void) const
	Return the TAO_Wait_Strategy used by this object.
int	handle_output (void)
	Callback method to reactively drain the outgoing data queue.
int	bidirectional_flag (void) const
	Get the bidirectional flag.
void	bidirectional_flag (int flag)
	Set the bidirectional flag.
void	cache_map_entry (TAO::Transport_Cache_Manager::HASH_MAP_ENTRY *entry)
	Set the Cache Map entry.
TAO::Transport_Cache_Manager::HASH_MAP_ENTRY *	cache_map_entry (void)
	Get the Cache Map entry.
size_t	id (void) const
	Set and Get the identifier for this transport instance.
void	id (size_t id)
TAO::Connection_Role	opened_as (void) const
void	opened_as (TAO::Connection_Role)
unsigned long	purging_order (void) const
void	purging_order (unsigned long value)
int	queue_is_empty (void)
	Check if there are messages pending in the queue.
void	provide_handler (TAO::Connection_Handler_Set &handlers)
	Added event handler to the handlers set.
bool	provide_blockable_handler (TAO::Connection_Handler_Set &handlers)
virtual int	register_handler (void)
	Register the handler with the reactor.
virtual ssize_t	send (iovec *iov, int iovcnt, size_t &bytes_transferred, const ACE_Time_Value *timeout=0)=0
	Write the complete Message_Block chain to the connection.
virtual ssize_t	recv (char *buffer, size_t len, const ACE_Time_Value *timeout=0)=0
	Read len bytes from into buf.
Control connection lifecycle
These methods are routed through the TMS object. The TMS strategies implement them correctly.
bool	idle_after_send (void)
bool	idle_after_reply (void)
virtual void	close_connection (void)
	Call the implementation method after obtaining the lock.
Template methods
The Transport class uses the Template Method Pattern to implement the protocol specific functionality. Implementors of a pluggable protocol should override the following methods with the semantics documented below.
virtual int	messaging_init (CORBA::Octet major, CORBA::Octet minor)=0
virtual int	tear_listen_point_list (TAO_InputCDR &cdr)
virtual bool	post_connect_hook (void)
	Hooks that can be overridden in concrete transports.
ACE_Event_Handler::Reference_Count	add_reference (void)
	Memory management routines.
ACE_Event_Handler::Reference_Count	remove_reference (void)
virtual TAO_Pluggable_Messaging *	messaging_object (void)=0

---

Detailed Description

Generic definitions for the Transport class.

The transport object is created in the Service handler constructor and deleted in the Service Handler's destructor!!

The main responsability of a Transport object is to encapsulate a connection, and provide a transport independent way to send and receive data. Since TAO is heavily based on the Reactor for all if not all its I/O the Transport class is usually implemented with a helper Connection Handler that adapts the generic Transport interface to the Reactor types.

The outgoing data path:

One of the responsibilities of the TAO_Transport class is to send out GIOP messages as efficiently as possible. In most cases messages are put out in FIFO order, the transport object will put out the message using a single system call and return control to the application. However, for oneways and AMI requests it may be more efficient (or required if the SYNC_NONE policy is in effect) to queue the messages until a large enough data set is available. Another reason to queue is that some applications cannot block for I/O, yet they want to send messages so large that a single write() operation would not be able to cope with them. In such cases we need to queue the data and use the Reactor to drain the queue.

Therefore, the Transport class may need to use a queue to temporarily hold the messages, and, in some configurations, it may need to use the Reactor to concurrently drain such queues.

Out of order messages:

TAO provides explicit policies to send 'urgent' messages. Such messages may put at the head of the queue. However, they cannot be sent immediately because the transport may already be sending another message in a reactive fashion.

Consequently, the Transport must also know if the head of the queue has been partially sent. In that case new messages can only follow the head. Only once the head is completely sent we can start sending new messages.

Waiting threads:

One or more threads can be blocked waiting for the connection to completely send the message. The thread should return as soon as its message has been sent, so a per-thread condition is required. This suggest that simply using a ACE_Message_Queue would not be enough: there is a significant amount of ancillary information, to keep on each message that the Message_Block class does not provide room for.

Blocking I/O is still attractive for some applications. First, my eliminating the Reactor overhead performance is improved when sending large blocks of data. Second, using the Reactor to send out data opens the door for nested upcalls, yet some applications cannot deal with the reentrancy issues in this case.

Timeouts:

Some or all messages could have a timeout period attached to them. The timeout source could either be some high-level policy or maybe some strategy to prevent denial of service attacks. In any case the timeouts are per-message, and later messages could have shorter timeouts. In fact, some kind of scheduling (such as EDF) could be required in a few applications.

Conclusions:

The outgoing data path consist in several components:

• A queue of pending messages
• A message currently being transmitted
• A per-transport 'send strategy' to choose between blocking on write, blocking on the reactor or blockin on leader/follower.
• A per-message 'waiting object'
• A per-message timeout

The Transport object provides a single method to send request messages (send_request_message ()).

The incoming data path:

One of the main responsibilities of the transport is to read and process the incoming GIOP message as quickly and efficiently as possible. There are other forces that needs to be given due consideration. They are

• Multiple threads should be able to traverse along the same data path but should not be able to read from the same handle at the same time ie. the handle should not be shared between threads at any instant.
• Reads on the handle could give one or more messages.
• Minimise locking and copying overhead when trying to attack the above.

Parsing messages (GIOP) & processing the message:

The messages should be checked for validity and the right information should be sent to the higher layer for processing. The process of doing a sanity check and preparing the messages for the higher layers of the ORB are done by the messaging protocol.

Design forces and Challenges

To keep things as efficient as possible for medium sized requests, it would be good to minimise data copying and locking along the incoming path ie. from the time of reading the data from the handle to the application. We achieve this by creating a buffer on stack and reading the data from the handle into the buffer. We then pass the same data block (the buffer is encapsulated into a data block) to the higher layers of the ORB. The problems stem from the following (a) Data is bigger than the buffer that we have on stack (b) Transports like TCP do not guarantee availability of the whole chunk of data in one shot. Data could trickle in byte by byte. (c) Single read gives multiple messages

We solve the problems as follows

(a) First do a read with the buffer on stack. Query the underlying messaging object whether the message has any incomplete portion. If so, data will be copied into new buffer being able to hold full message and is queued; succeeding events will read data from socket and write directly into this buffer. Otherwise, if if the message in local buffer is complete, we free the handle and then send the message to the higher layers of the ORB for processing.

(b) If buffer with incomplete message has been enqueued, while trying to do the above, the reactor will call us back when the handle becomes read ready. The read-operation will copy data directly into the enqueued buffer. If the message has bee read completely the message is sent to the higher layers of the ORB for processing.

(c) If we get multiple messages (possible if the client connected to the server sends oneways or AMI requests), we parse and split the messages. Every message is put in the queue. Once the messages are queued, the thread picks up one message to send to the higher layers of the ORB. Before doing that, if it finds more messages, it sends a notify to the reactor without resuming the handle. The next thread picks up a message from the queue and processes that. Once the queue is drained the last thread resumes the handle.

Sending Replies

We could use the outgoing path of the ORB to send replies. This would allow us to reuse most of the code in the outgoing data path. We were doing this till TAO-1.2.3. We run in to problems. When writing the reply the ORB gets flow controlled, and the ORB tries to flush the message by going into the reactor. This resulted in unnecessary nesting. The thread that gets into the Reactor could potentially handle other messages (incoming or outgoing) and the stack starts growing leading to crashes.

Solution to the nesting problem

The solution that we (plan to) adopt is pretty straight forward. The thread sending replies will not block to send the replies but queue the replies and return to the Reactor. (Note the careful usages of the terms "blocking in the Reactor" as opposed to "return back to the Reactor".

See Also:

http://cvs.doc.wustl.edu/ace-latest.cgi/ACE_wrappers/TAO/docs/pluggable_protocols/index.html

Definition at line 237 of file Transport.h.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: TAO_ONEWAY_REQUEST  TAO_TWOWAY_REQUEST  TAO_REPLY  Definition at line 592 of file Transport.h. { TAO_ONEWAY_REQUEST = 0, TAO_TWOWAY_REQUEST = 1, TAO_REPLY };

---

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_Transport::TAO_Transport (  CORBA::ULong  tag, TAO_ORB_Core *  orb_core )

Default creator, requires the tag value be supplied. Definition at line 118 of file Transport.cpp. References TAO_ORB_Core::client_factory(), TAO_Client_Strategy_Factory::create_transport_mux_strategy(), and TAO_Client_Strategy_Factory::create_wait_strategy(). : tag_ (tag) , orb_core_ (orb_core) , cache_map_entry_ (0) , bidirectional_flag_ (-1) , opening_connection_role_ (TAO::TAO_UNSPECIFIED_ROLE) , head_ (0) , tail_ (0) , incoming_message_queue_ (orb_core) , current_deadline_ (ACE_Time_Value::zero) , flush_timer_id_ (-1) , transport_timer_ (this) , handler_lock_ (orb_core->resource_factory ()->create_cached_connection_lock ()) , id_ ((size_t) this) , purging_order_ (0) , recv_buffer_size_ (0) , sent_byte_count_ (0) , is_connected_ (false) , char_translator_ (0) , wchar_translator_ (0) , tcs_set_ (0) , first_request_ (1) , partial_message_ (0) #ifdef ACE_HAS_SENDFILE // The ORB has been configured to use the MMAP allocator, meaning // we could/should use sendfile() to send data. Cast once rather // here rather than during each send. This assumes that all // TAO_OutputCDR instances are using the same TAO_MMAP_Allocator // instance as the underlying output CDR buffer allocator. , mmap_allocator_ ( dynamic_cast<TAO_MMAP_Allocator *> ( orb_core->output_cdr_buffer_allocator ())) #endif /* ACE_HAS_SENDFILE */ { TAO_Client_Strategy_Factory *cf = this->orb_core_->client_factory (); // Create WS now. this->ws_ = cf->create_wait_strategy (this); // Create TMS now. this->tms_ = cf->create_transport_mux_strategy (this); /* * Hook to add code that initializes components that * belong to the concrete protocol implementation. * Further additions to this Transport class will * need to add code *before* this hook. */ //@@ TAO_TRANSPORT_SPL_CONSTRUCTOR_ADD_HOOK }

TAO_Transport::~TAO_Transport (  void   )  [virtual]

Destructor. Definition at line 171 of file Transport.cpp. References ACE_ASSERT, cleanup_queue_i(), handler_lock_, is_connected_, purge_entry(), and ACE_Message_Block::release(). { delete this->ws_; delete this->tms_; delete this->handler_lock_; if (!this->is_connected_) { // When we have a not connected transport we could have buffered // messages on this transport which we have to cleanup now. this->cleanup_queue_i(); // Cleanup our cache entry this->purge_entry(); } // Release the partial message block, however we may // have never allocated one. ACE_Message_Block::release (this->partial_message_); // By the time the destructor is reached here all the connection stuff // *must* have been cleaned up. // The following assert is needed for the test "Bug_2494_Regression". // See the bugzilla bug #2494 for details. ACE_ASSERT (this->head_ == 0); ACE_ASSERT (this->cache_map_entry_ == 0); /* * Hook to add code that cleans up components * belong to the concrete protocol implementation. * Further additions to this Transport class will * need to add code *before* this hook. */ //@@ TAO_TRANSPORT_SPL_DESTRUCTOR_ADD_HOOK }

TAO_Transport::TAO_Transport (  const TAO_Transport &   )  [private]

---

Member Function Documentation

ACE_Event_Handler::Reference_Count TAO_Transport::add_reference (  void   )

Memory management routines. Definition at line 2352 of file Transport.cpp. References ACE_Event_Handler::add_reference(), and event_handler_i(). Referenced by TAO::Cache_IntId::Cache_IntId(), TAO::Cache_IntId::operator=(), provide_blockable_handler(), provide_handler(), TAO::Transport_Cache_Manager::purge(), TAO_Thread_Per_Connection_Handler::TAO_Thread_Per_Connection_Handler(), and TAO_Asynch_Reply_Dispatcher_Base::transport(). { return this->event_handler_i ()->add_reference (); }

void TAO_Transport::allocate_partial_message_block (  void   )  [private]

Allocate a partial message block and store it in our partial_message_ data member. Definition at line 2421 of file Transport.cpp. References ACE_NEW, TAO_Pluggable_Messaging::header_length(), messaging_object(), and partial_message_. Referenced by handle_input_parse_data(). { if (this->partial_message_ == 0) { // This value must be at least large enough to hold a GIOP message // header plus a GIOP fragment header const size_t partial_message_size = this->messaging_object ()->header_length (); // + this->messaging_object ()->fragment_header_length (); // deprecated, conflicts with not-single_read_opt. ACE_NEW (this->partial_message_, ACE_Message_Block (partial_message_size)); } }

void TAO_Transport::assign_translators (  TAO_InputCDR *  , TAO_OutputCDR *  )

Use the Transport's codeset factories to set the translator for input and output CDRs. Definition at line 2322 of file Transport.cpp. References TAO_Codeset_Translator_Base::assign(). Referenced by TAO::LocateRequest_Invocation::check_reply(), TAO::Synch_Twoway_Invocation::check_reply_status(), TAO_ServerRequest::init_reply(), TAO_GIOP_Message_Lite::process_request(), TAO_GIOP_Message_Base::process_request(), TAO_GIOP_Message_Lite::process_request_message(), TAO_GIOP_Message_Base::process_request_message(), TAO_ServerRequest::send_cached_reply(), TAO_GIOP_Message_Lite::send_reply_exception(), TAO_ServerRequest::tao_send_reply_exception(), and TAO::Remote_Invocation::write_header(). { if (this->char_translator_) { this->char_translator_->assign (inp); this->char_translator_->assign (outp); } if (this->wchar_translator_) { this->wchar_translator_->assign (inp); this->wchar_translator_->assign (outp); } }

ACE_INLINE void TAO_Transport::bidirectional_flag (  int  flag  )

Set the bidirectional flag. Definition at line 39 of file Transport.inl. References bidirectional_flag_. { this->bidirectional_flag_ = flag; }

ACE_INLINE int TAO_Transport::bidirectional_flag (  void   )  const

Get the bidirectional flag. Definition at line 33 of file Transport.inl. References bidirectional_flag_. Referenced by TAO::Wait_On_LF_No_Upcall::can_process_upcalls(), TAO_IIOP_Transport::generate_request_header(), TAO_Muxed_TMS::request_id(), TAO_Exclusive_TMS::request_id(), and TAO_IIOP_Transport::tear_listen_point_list(). { return this->bidirectional_flag_; }

ACE_INLINE TAO::Transport_Cache_Manager::HASH_MAP_ENTRY * TAO_Transport::cache_map_entry (  void   )

Get the Cache Map entry. Definition at line 57 of file Transport.inl. References cache_map_entry_. { return this->cache_map_entry_; }

ACE_INLINE void TAO_Transport::cache_map_entry (  TAO::Transport_Cache_Manager::HASH_MAP_ENTRY *  entry  )

Set the Cache Map entry. Definition at line 63 of file Transport.inl. References cache_map_entry_, and TAO::Transport_Cache_Manager::HASH_MAP_ENTRY. Referenced by TAO::Transport_Cache_Manager::bind_i(). { this->cache_map_entry_ = entry; }

int TAO_Transport::cancel_output_i (  void   )  [private]

Cancel handle_output() callbacks. Definition at line 759 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, ACE_Reactor::cancel_wakeup(), event_handler_i(), LM_DEBUG, ACE_Event_Handler::reactor(), and TAO_debug_level. Referenced by TAO_Reactive_Flushing_Strategy::cancel_output(), and TAO_Leader_Follower_Flushing_Strategy::cancel_output(). { ACE_Event_Handler * const eh = this->event_handler_i (); ACE_Reactor *const reactor = eh->reactor (); if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::cancel_output_i\n"), this->id ())); } return reactor->cancel_wakeup (eh, ACE_Event_Handler::WRITE_MASK); }

ACE_INLINE void TAO_Transport::char_translator (  TAO_Codeset_Translator_Base *   )

CodeSet negotiation - Set the char codeset translator factory. Definition at line 137 of file Transport.inl. References tcs_set_. { this->char_translator_ = tf; this->tcs_set_ = 1; }

ACE_INLINE TAO_Codeset_Translator_Base * TAO_Transport::char_translator (  void   )  const

CodeSet Negotiation - Get the char codeset translator factory. Definition at line 125 of file Transport.inl. { return this->char_translator_; }

int TAO_Transport::check_buffering_constraints_i (  TAO_Stub *  stub, bool &  must_flush )  [private]

Check if the buffering constraints have been reached. Definition at line 1056 of file Transport.cpp. References ACE_Reactor::cancel_timer(), current_deadline_, event_handler_i(), flush_timer_id_, flush_timer_pending(), ACE_OS::gettimeofday(), TAO_Queued_Message::message_length(), TAO_Queued_Message::next(), ACE_Event_Handler::reactor(), ACE_Reactor::schedule_timer(), and TAO_Stub::transport_queueing_strategy(). Referenced by send_asynchronous_message_i(). { // First let's compute the size of the queue: size_t msg_count = 0; size_t total_bytes = 0; for (TAO_Queued_Message *i = this->head_; i != 0; i = i->next ()) { ++msg_count; total_bytes += i->message_length (); } bool set_timer; ACE_Time_Value new_deadline; bool constraints_reached = stub->transport_queueing_strategy (). buffering_constraints_reached (stub, msg_count, total_bytes, must_flush, this->current_deadline_, set_timer, new_deadline); // ... set the new timer, also cancel any previous timers ... if (set_timer) { ACE_Event_Handler *eh = this->event_handler_i (); ACE_Reactor *reactor = eh->reactor (); this->current_deadline_ = new_deadline; ACE_Time_Value delay = new_deadline - ACE_OS::gettimeofday (); if (this->flush_timer_pending ()) { reactor->cancel_timer (this->flush_timer_id_); } this->flush_timer_id_ = reactor->schedule_timer (&this->transport_timer_, &this->current_deadline_, delay); } return constraints_reached; }

void TAO_Transport::cleanup_queue (  size_t  byte_count  )  [private]

Cleanup the queue. Exactly byte_count bytes have been sent, the queue must be cleaned up as potentially several messages have been completely sent out. It leaves on head_ the next message to send out. Definition at line 1019 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, TAO_Queued_Message::all_data_sent(), TAO_Queued_Message::bytes_transferred(), TAO_Queued_Message::destroy(), LM_DEBUG, TAO_Queued_Message::message_length(), TAO_Queued_Message::remove_from_list(), and TAO_debug_level. Referenced by drain_queue_helper(). { while (this->head_ != 0 && byte_count > 0) { TAO_Queued_Message *i = this->head_; if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::cleanup_queue, ") ACE_TEXT ("byte_count = %d\n"), this->id (), byte_count)); } // Update the state of the first message i->bytes_transferred (byte_count); if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::cleanup_queue, ") ACE_TEXT ("after transfer, bc = %d, all_sent = %d, ml = %d\n"), this->id (), byte_count, i->all_data_sent (), i->message_length ())); } // ... if all the data was sent the message must be removed from // the queue... if (i->all_data_sent ()) { i->remove_from_list (this->head_, this->tail_); i->destroy (); } } }

void TAO_Transport::cleanup_queue_i (   )  [private]

Cleanup the complete queue. Definition at line 992 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, TAO_Queued_Message::destroy(), LM_DEBUG, TAO_Queued_Message::remove_from_list(), TAO_LF_Event::state_changed(), and TAO_debug_level. Referenced by send_connection_closed_notifications_i(), and ~TAO_Transport(). { if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::cleanup_queue_i, ") ACE_TEXT ("cleaning up complete queue\n"), this->id ())); } // Cleanup all messages while (this->head_ != 0) { TAO_Queued_Message *i = this->head_; // @@ This is a good point to insert a flag to indicate that a // CloseConnection message was successfully received. i->state_changed (TAO_LF_Event::LFS_CONNECTION_CLOSED, this->orb_core_->leader_follower ()); i->remove_from_list (this->head_, this->tail_); i->destroy (); } }

void TAO_Transport::clear_translators (  TAO_InputCDR *  , TAO_OutputCDR *  )

It is necessary to clear the codeset translator when a CDR stream is used for more than one GIOP message. This is required since the header must not be translated, whereas the body must be. Definition at line 2337 of file Transport.cpp. References ACE_OutputCDR::char_translator(), ACE_InputCDR::char_translator(), ACE_OutputCDR::wchar_translator(), and ACE_InputCDR::wchar_translator(). Referenced by TAO::Remote_Invocation::write_header(). { if (inp) { inp->char_translator (0); inp->wchar_translator (0); } if (outp) { outp->char_translator (0); outp->wchar_translator (0); } }

void TAO_Transport::close_connection (  void   )  [virtual]

Call the implementation method after obtaining the lock. Definition at line 293 of file Transport.cpp. References TAO_Connection_Handler::close_connection(), and connection_handler_i(). Referenced by TAO_IIOP_Connector::complete_connection(), TAO_Connector::connect(), post_open(), TAO::Transport_Cache_Manager::purge(), TAO_GIOP_Message_Base::send_close_connection(), TAO::Remote_Invocation::send_message(), send_message_shared(), TAO_IIOP_Transport::send_message_shared(), and TAO_Wait_On_Read::wait(). { this->connection_handler_i ()->close_connection (); }

ACE_INLINE TAO_Connection_Handler * TAO_Transport::connection_handler (  void   )

Get the connection handler for this transport. Definition at line 175 of file Transport.inl. References connection_handler_i(). Referenced by TAO_IIOP_Connector::complete_connection(), TAO::Remote_Invocation::send_message(), TAO_Connect_Strategy::wait(), and TAO_Connector::wait_for_connection_completion(). { return this->connection_handler_i(); }

virtual TAO_Connection_Handler* TAO_Transport::connection_handler_i (  void   )  [protected, pure virtual]

Implemented in TAO_IIOP_Transport. Referenced by close_connection(), and connection_handler().

int TAO_Transport::consolidate_enqueue_message (  TAO_Queued_Data *  qd  )  [private]

-1 error, otherwise 0 Definition at line 1491 of file Transport.cpp. References ACE_ERROR, ACE_TEXT, TAO_Pluggable_Messaging::consolidate_fragmented_message(), TAO_Incoming_Message_Queue::enqueue_tail(), incoming_message_queue_, LM_ERROR, messaging_object(), TAO_Queued_Data::missing_data_, TAO_Queued_Data::more_fragments_, TAO_Queued_Data::msg_type_, TAO_Queued_Data::release(), TAO_debug_level, and TAO_PLUGGABLE_MESSAGE_FRAGMENT. Referenced by handle_input_parse_data(), and handle_input_parse_extra_messages(). { // consolidate message on top of stack, only for fragmented messages // paranoid check if (q_data->missing_data_ != 0) { return -1; } if (q_data->more_fragments_ || q_data->msg_type_ == TAO_PLUGGABLE_MESSAGE_FRAGMENT) { TAO_Queued_Data *new_q_data = 0; switch (this->messaging_object()->consolidate_fragmented_message (q_data, new_q_data)) { case -1: // error return -1; case 0: // returning consolidated message in new_q_data if (!new_q_data) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::consolidate_enqueue_message, ") ACE_TEXT ("error, consolidated message is NULL\n"), this->id ())); } return -1; } if (this->incoming_message_queue_.enqueue_tail (new_q_data) != 0) { TAO_Queued_Data::release (new_q_data); return -1; } break; case 1: // fragment has been stored in messaging_oject() break; } } else { if (this->incoming_message_queue_.enqueue_tail (q_data) != 0) { TAO_Queued_Data::release (q_data); return -1; } } return 0; // success }

int TAO_Transport::consolidate_process_message (  TAO_Queued_Data *  qd, TAO_Resume_Handle &  rh )  [private]

-1 error, otherwise 0 Definition at line 1404 of file Transport.cpp. References ACE_ERROR, ACE_TEXT, TAO_Pluggable_Messaging::consolidate_fragmented_message(), LM_ERROR, messaging_object(), TAO_Queued_Data::missing_data_, TAO_Queued_Data::more_fragments_, TAO_Queued_Data::msg_type_, process_parsed_messages(), TAO_Queued_Data::release(), TAO_debug_level, and TAO_PLUGGABLE_MESSAGE_FRAGMENT. Referenced by handle_input_missing_data(). { // paranoid check if (q_data->missing_data_ != 0) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::consolidate_process_message, ") ACE_TEXT ("missing data\n"), this->id ())); } return -1; } if (q_data->more_fragments_ || q_data->msg_type_ == TAO_PLUGGABLE_MESSAGE_FRAGMENT) { // consolidate message on top of stack, only for fragmented messages TAO_Queued_Data *new_q_data = 0; switch (this->messaging_object()->consolidate_fragmented_message (q_data, new_q_data)) { case -1: // error return -1; case 0: // returning consolidated message in q_data if (!new_q_data) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::consolidate_process_message, ") ACE_TEXT ("error, consolidated message is NULL\n"), this->id ())); } return -1; } if (this->process_parsed_messages (new_q_data, rh) == -1) { TAO_Queued_Data::release (new_q_data); if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::consolidate_process_message, ") ACE_TEXT ("error processing consolidated message\n"), this->id ())); } return -1; } TAO_Queued_Data::release (new_q_data); break; case 1: // fragment has been stored in messaging_oject() break; } } else { if (this->process_parsed_messages (q_data, rh) == -1) { TAO_Queued_Data::release (q_data); if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::consolidate_process_message, ") ACE_TEXT ("error processing message\n"), this->id ())); } return -1; } TAO_Queued_Data::release (q_data); } return 0; }

int TAO_Transport::drain_queue (  void   )  [private]

Send some of the data in the queue. As the outgoing data is drained this method is invoked to send as much of the current message as possible. Returns 0 if there is more data to send, -1 if there was an error and 1 if the message was completely sent. Definition at line 807 of file Transport.cpp. References ACE_GUARD_RETURN, TAO_Flushing_Strategy::cancel_output(), drain_queue_i(), TAO_ORB_Core::flushing_strategy(), and orb_core(). Referenced by handle_output(). { ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, -1); int const retval = this->drain_queue_i (); if (retval == 1) { // ... there is no current message or it was completely // sent, cancel output... TAO_Flushing_Strategy *flushing_strategy = this->orb_core ()->flushing_strategy (); flushing_strategy->cancel_output (this); return 0; } return retval; }

int TAO_Transport::drain_queue_helper (  int &  iovcnt, iovec  iov[] )  [private]

A helper routine used in drain_queue_i(). Definition at line 828 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, cleanup_queue(), dump_iov(), EWOULDBLOCK, LM_DEBUG, send(), sent_byte_count_, ssize_t, and TAO_debug_level. Referenced by drain_queue_i(). { size_t byte_count = 0; // ... send the message ... ssize_t retval = -1; #ifdef ACE_HAS_SENDFILE if (this->mmap_allocator_) retval = this->sendfile (this->mmap_allocator_, iov, iovcnt, byte_count); else #endif /* ACE_HAS_SENDFILE */ retval = this->send (iov, iovcnt, byte_count); if (TAO_debug_level == 5) { dump_iov (iov, iovcnt, this->id (), byte_count, "drain_queue_helper"); } // ... now we need to update the queue, removing elements // that have been sent, and updating the last element if it // was only partially sent ... this->cleanup_queue (byte_count); iovcnt = 0; if (retval == 0) { if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::drain_queue_helper, ") ACE_TEXT ("send() returns 0\n"), this->id ())); } return -1; } else if (retval == -1) { if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::drain_queue_helper, ") ACE_TEXT ("error during %p\n"), this->id (), ACE_TEXT ("send()"))); } if (errno == EWOULDBLOCK || errno == EAGAIN) { return 0; } return -1; } // ... start over, how do we guarantee progress? Because if // no bytes are sent send() can only return 0 or -1 // Total no. of bytes sent for a send call this->sent_byte_count_ += byte_count; if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::drain_queue_helper, ") ACE_TEXT ("byte_count = %d, head_is_empty = %d\n"), this->id(), byte_count, (this->head_ == 0))); } return 1; }

int TAO_Transport::drain_queue_i (  void   )  [private]

Implement drain_queue() assuming the lock is held. Definition at line 904 of file Transport.cpp. References ACE_DEBUG, ACE_IOV_MAX, ACE_TEXT, ACE_Reactor::cancel_timer(), drain_queue_helper(), event_handler_i(), TAO_Queued_Message::fill_iov(), flush_timer_pending(), LM_DEBUG, TAO_Queued_Message::next(), ACE_Event_Handler::reactor(), reset_flush_timer(), sent_byte_count_, and TAO_debug_level. Referenced by drain_queue(), TAO_Block_Flushing_Strategy::schedule_output(), send_message_block_chain_i(), and send_synch_message_helper_i(). { // This is the vector used to send data, it must be declared outside // the loop because after the loop there may still be data to be // sent int iovcnt = 0; #if defined (ACE_INITIALIZE_MEMORY_BEFORE_USE) iovec iov[ACE_IOV_MAX] = { 0 , 0 }; #else iovec iov[ACE_IOV_MAX]; #endif /* ACE_INITIALIZE_MEMORY_BEFORE_USE */ // We loop over all the elements in the queue ... TAO_Queued_Message *i = this->head_; // Reset the value so that the counting is done for each new send // call. this->sent_byte_count_ = 0; while (i != 0) { // ... each element fills the iovector ... i->fill_iov (ACE_IOV_MAX, iovcnt, iov); // ... the vector is full, no choice but to send some data out. // We need to loop because a single message can span multiple // IOV_MAX elements ... if (iovcnt == ACE_IOV_MAX) { int const retval = this->drain_queue_helper (iovcnt, iov); if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::drain_queue_i, ") ACE_TEXT ("helper retval = %d\n"), this->id (), retval)); } if (retval != 1) { return retval; } i = this->head_; continue; } // ... notice that this line is only reached if there is still // room in the iovector ... i = i->next (); } if (iovcnt != 0) { int const retval = this->drain_queue_helper (iovcnt, iov); if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::drain_queue_i, ") ACE_TEXT ("helper retval = %d\n"), this->id (), retval)); } if (retval != 1) { return retval; } } if (this->head_ == 0) { if (this->flush_timer_pending ()) { ACE_Event_Handler *eh = this->event_handler_i (); ACE_Reactor * const reactor = eh->reactor (); reactor->cancel_timer (this->flush_timer_id_); this->reset_flush_timer (); } return 1; } return 0; }

virtual ACE_Event_Handler* TAO_Transport::event_handler_i (  void   )  [pure virtual]

Normally a concrete TAO_Transport object has-a ACE_Event_Handler member that functions as an adapter between the ACE_Reactor framework and the TAO pluggable protocol framework. In all the protocols implemented so far this role is fullfilled by an instance of ACE_Svc_Handler. Todo: Since we only use a limited functionality of ACE_Svc_Handler we could probably implement a generic adapter class (TAO_Transport_Event_Handler or something), this will reduce footprint and simplify the process of implementing a pluggable protocol. This method has to be renamed to event_handler() Implemented in TAO_IIOP_Transport. Referenced by add_reference(), cancel_output_i(), check_buffering_constraints_i(), drain_queue_i(), TAO::Transport_Cache_Manager::find_transport(), notify_reactor(), register_handler(), remove_reference(), schedule_output_i(), TAO_Connection_Handler::transport(), and TAO_Wait_On_Read::wait().

ACE_INLINE void TAO_Transport::first_request_sent (   )

Set the state of the first_request_ flag to 0. Definition at line 158 of file Transport.inl. References first_request_. Referenced by TAO_IIOP_Transport::send_request(). { this->first_request_ = 0; }

ACE_INLINE int TAO_Transport::flush_timer_pending (  void   )  const [private]

Check if the flush timer is still pending. Definition at line 108 of file Transport.inl. References flush_timer_id_. Referenced by check_buffering_constraints_i(), drain_queue_i(), and handle_timeout(). { return this->flush_timer_id_ != -1; }

int TAO_Transport::format_queue_message (  TAO_OutputCDR &  stream  )

Format and queue a message for stream. Definition at line 481 of file Transport.cpp. References ACE_OutputCDR::begin(), TAO_Pluggable_Messaging::format_message(), messaging_object(), and queue_message_i(). Referenced by TAO::Synch_Oneway_Invocation::remote_oneway(). { if (this->messaging_object ()->format_message (stream) != 0) return -1; return this->queue_message_i (stream.begin()); }

int TAO_Transport::generate_locate_request (  TAO_Target_Specification &  spec, TAO_Operation_Details &  opdetails, TAO_OutputCDR &  output )

This is a request for the transport object to write a LocateRequest header before it is sent out. Definition at line 352 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, TAO_Pluggable_Messaging::generate_locate_request_header(), LM_DEBUG, messaging_object(), and TAO_debug_level. Referenced by TAO::LocateRequest_Invocation::invoke(). { if (this->messaging_object ()->generate_locate_request_header (opdetails, spec, output) == -1) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::generate_locate_request, ") ACE_TEXT ("error while marshalling the LocateRequest header\n"), this->id ())); } return -1; } return 0; }

int TAO_Transport::generate_request_header (  TAO_Operation_Details &  opd, TAO_Target_Specification &  spec, TAO_OutputCDR &  msg )  [virtual]

This is a request for the transport object to write a request header before it sends out the request Reimplemented in TAO_IIOP_Transport. Definition at line 377 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, TAO_ORB_Core::codeset_manager(), first_request_, TAO_Pluggable_Messaging::generate_request_header(), TAO_Codeset_Manager::generate_service_context(), LM_DEBUG, messaging_object(), orb_core(), and TAO_debug_level. Referenced by TAO_IIOP_Transport::generate_request_header(), and TAO::Remote_Invocation::write_header(). { // codeset service context is only supposed to be sent in the first request // on a particular connection. if (this->first_request_) { TAO_Codeset_Manager * const csm = this->orb_core ()->codeset_manager (); if (csm) csm->generate_service_context (opdetails,*this); } if (this->messaging_object ()->generate_request_header (opdetails, spec, output) == -1) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("(%P|%t) - Transport[%d]::generate_request_header, ") ACE_TEXT ("error while marshalling the Request header\n"), this->id())); } return -1; } return 0; }

int TAO_Transport::handle_input (  TAO_Resume_Handle &  rh, ACE_Time_Value *  max_wait_time = 0, int  block = 0 )  [virtual]

Callback to read incoming data. The ACE_Event_Handler adapter invokes this method as part of its handle_input() operation. Todo: the method name is confusing! Calling it handle_input() would probably make things easier to understand and follow! Once a complete message is read the Transport class delegates on the Messaging layer to invoke the right upcall (on the server) or the TAO_Reply_Dispatcher (on the client side). Parameters: max_wait_time  In some cases the I/O is synchronous, e.g. a thread-per-connection server or when Wait_On_Read is enabled. In those cases a maximum read time can be specified. block  Is deprecated and ignored. Definition at line 1329 of file Transport.cpp. References ACE_DEBUG, ACE_ERROR, ACE_TEXT, handle_input_missing_data(), handle_input_parse_data(), incoming_message_stack_, LM_DEBUG, LM_ERROR, TAO_Queued_Data::missing_data_, process_queue_head(), TAO_debug_level, TAO_MISSING_DATA_UNDEFINED, and TAO::Incoming_Message_Stack::top(). Referenced by TAO_Connection_Handler::handle_input_internal(), TAO_Connection_Handler::svc_i(), and TAO_Wait_On_Read::wait(). { if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input\n"), this->id ())); } // First try to process messages of the head of the incoming queue. int const retval = this->process_queue_head (rh); if (retval <= 0) { if (retval == -1) { if (TAO_debug_level > 2) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input, ") ACE_TEXT ("error while parsing the head of the queue\n"), this->id())); } return -1; } else { // retval == 0 // Processed a message in queue successfully. This // thread must return to thread-pool now. return 0; } } TAO_Queued_Data *q_data = 0; if (this->incoming_message_stack_.top (q_data) != -1 && q_data->missing_data_ != TAO_MISSING_DATA_UNDEFINED) { /* PRE: q_data->missing_data_ > 0 as all QD on stack must be incomplete */ if (this->handle_input_missing_data (rh, max_wait_time, q_data) == -1) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input, ") ACE_TEXT ("error consolidating incoming message\n"), this->id ())); } return -1; } } else { if (this->handle_input_parse_data (rh, max_wait_time) == -1) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input, ") ACE_TEXT ("error parsing incoming message\n"), this->id ())); } return -1; } } return 0; }

int TAO_Transport::handle_input_missing_data (  TAO_Resume_Handle &  rh, ACE_Time_Value *  max_wait_time, TAO_Queued_Data *  q_data )  [private]

Is invoked by handle_input operation. It consolidate message on top of incoming_message_stack. The amount of missing data is known and recv operation copies data directly into message buffer, as much as a single recv-invocation provides. Definition at line 1548 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, consolidate_process_message(), ACE_CDR::grow(), incoming_message_stack_, ACE_Message_Block::length(), LM_DEBUG, TAO_Queued_Data::missing_data_, TAO_Queued_Data::msg_block_, TAO::Incoming_Message_Stack::pop(), recv(), ACE_Message_Block::space(), ssize_t, TAO_debug_level, and ACE_Message_Block::wr_ptr(). Referenced by handle_input(). { // paranoid check if (q_data == 0) { return -1; } if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_missing_data_message, ") ACE_TEXT ("enter (missing data == %d)\n"), this->id (), q_data->missing_data_)); } size_t const recv_size = q_data->missing_data_; // make sure the message_block has enough space size_t const message_size = recv_size + q_data->msg_block_->length(); if (q_data->msg_block_->space() < recv_size) { if (ACE_CDR::grow (q_data->msg_block_, message_size) == -1) { return -1; } } // Saving the size of the received buffer in case any one needs to // get the size of the message thats received in the // context. Obviously the value will be changed for each recv call // and the user is supposed to invoke the accessor only in the // invocation context to get meaningful information. this->recv_buffer_size_ = recv_size; // Read the message into the existing message block on heap ssize_t const n = this->recv (q_data->msg_block_->wr_ptr(), recv_size, max_wait_time); if (n <= 0) { return n; } if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_missing_data_message, ") ACE_TEXT ("read bytes %d\n"), this->id (), n)); } q_data->msg_block_->wr_ptr(n); q_data->missing_data_ -= n; if (q_data->missing_data_ == 0) { // paranoid check if (this->incoming_message_stack_.pop (q_data) == -1) { return -1; } if (this->consolidate_process_message (q_data, rh) == -1) { return -1; } } return 0; }

int TAO_Transport::handle_input_parse_data (  TAO_Resume_Handle &  rh, ACE_Time_Value *  max_wait_time )  [private]

Is invoked by handle_input operation. It parses new messages from input stream or consolidates messages whose header has been partially read, the message size being unknown so far. It parses as much data as a single recv-invocation provides. Definition at line 1671 of file Transport.cpp. References ACE_DEBUG, ACE_ERROR, ACE_TEXT, allocate_partial_message_block(), consolidate_enqueue_message(), TAO_Pluggable_Messaging::consolidate_node(), ACE_Message_Block::copy(), TAO_Queued_Data::duplicate(), ACE_CDR::grow(), handle_input_parse_extra_messages(), TAO_Pluggable_Messaging::header_length(), incoming_message_queue_, incoming_message_stack_, TAO_ORB_Core::input_cdr_dblock_allocator(), ACE_Message_Block::length(), LM_DEBUG, LM_ERROR, TAO_ORB_Core::locking_strategy(), ACE_CDR::mb_align(), ACE_OS::memset(), messaging_object(), TAO_Queued_Data::missing_data_, TAO_Queued_Data::more_fragments_, TAO_Queued_Data::msg_block_, TAO_Queued_Data::msg_type_, notify_reactor(), TAO_ORB_Core::orb_params(), TAO_Pluggable_Messaging::parse_next_message(), partial_message_, TAO::Incoming_Message_Stack::pop(), process_parsed_messages(), process_queue_head(), TAO::Incoming_Message_Stack::push(), TAO_Incoming_Message_Queue::queue_length(), ACE_Message_Block::rd_ptr(), recv(), ACE_Message_Block::reset(), TAO_Resume_Handle::set_flag(), TAO_ORB_Parameters::single_read_optimization(), ACE_Message_Block::space(), ssize_t, TAO_debug_level, TAO_MAXBUFSIZE, TAO_MISSING_DATA_UNDEFINED, TAO_PLUGGABLE_MESSAGE_FRAGMENT, TAO::Incoming_Message_Stack::top(), and ACE_Message_Block::wr_ptr(). Referenced by handle_input(). { if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_parse_data, ") ACE_TEXT ("enter\n"), this->id ())); } // The buffer on the stack which will be used to hold the input // messages, ACE_CDR::MAX_ALIGNMENT compensates the // memory-alignment. This improves performance with SUN-Java-ORB-1.4 // and higher that sends fragmented requests of size 1024 bytes. char buf [TAO_MAXBUFSIZE + ACE_CDR::MAX_ALIGNMENT]; #if defined (ACE_INITIALIZE_MEMORY_BEFORE_USE) (void) ACE_OS::memset (buf, '\0', sizeof buf); #endif /* ACE_INITIALIZE_MEMORY_BEFORE_USE */ // Create a data block ACE_Data_Block db (sizeof (buf), ACE_Message_Block::MB_DATA, buf, this->orb_core_->input_cdr_buffer_allocator (), this->orb_core_->locking_strategy (), ACE_Message_Block::DONT_DELETE, this->orb_core_->input_cdr_dblock_allocator ()); // Create a message block ACE_Message_Block message_block (&db, ACE_Message_Block::DONT_DELETE, this->orb_core_->input_cdr_msgblock_allocator ()); // Align the message block ACE_CDR::mb_align (&message_block); size_t recv_size = 0; // Note: unsigned integer // Pointer to newly parsed message TAO_Queued_Data *q_data = 0; // optimizing access of constants const size_t header_length = this->messaging_object ()->header_length (); // paranoid check if (header_length > message_block.space ()) { return -1; } if (this->orb_core_->orb_params ()->single_read_optimization ()) { recv_size = message_block.space (); } else { // Single read optimization has been de-activated. That means // that we need to read from transport the GIOP header first // before the payload. This codes first checks the incoming // stack for partial messages which needs to be // consolidated. Otherwise we are in new cycle, reading complete // GIOP header of new incoming message. if (this->incoming_message_stack_.top (q_data) != -1 && q_data->missing_data_ == TAO_MISSING_DATA_UNDEFINED) { // There is a partial message on incoming_message_stack_ // whose length is unknown so far. We need to consolidate // the GIOP header to get to know the payload size, recv_size = header_length - q_data->msg_block_->length (); } else { // Read amount of data forming GIOP header of new incoming // message. recv_size = header_length; } // POST: 0 <= recv_size <= header_length } // POST: 0 <= recv_size <= message_block->space () // If we have a partial message, copy it into our message block and // clear out the partial message. if (this->partial_message_ != 0 && this->partial_message_->length () > 0) { // (*) Copy back the partial message into current read-buffer, // verify that the read-strategy of "recv_size" bytes is not // exceeded. The latter check guarantees that recv_size does not // roll-over and keeps in range // 0<=recv_size<=message_block->space() if (this->partial_message_->length () <= recv_size && message_block.copy (this->partial_message_->rd_ptr (), this->partial_message_->length ()) == 0) { recv_size -= this->partial_message_->length (); this->partial_message_->reset (); } else { return -1; } } // POST: 0 <= recv_size <= buffer_space if (0 >= recv_size) // paranoid: the check above (*) guarantees recv_size>=0 { // This event would cause endless looping, trying frequently to // read zero bytes from stream. This might happen, if TAOs // protocol implementation is not correct and tries to read data // beyond header without "single_read_optimazation" being // activated. if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_parse_data, ") ACE_TEXT ("Error - endless loop detection, closing connection"), this->id ())); } return -1; } // Saving the size of the received buffer in case any one needs to // get the size of the message thats received in the // context. Obviously the value will be changed for each recv call // and the user is supposed to invoke the accessor only in the // invocation context to get meaningful information. this->recv_buffer_size_ = recv_size; // Read the message into the message block that we have created on // the stack. const ssize_t n = this->recv (message_block.wr_ptr (), recv_size, max_wait_time); // If there is an error return to the reactor.. if (n <= 0) { return n; } if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_parse_data, ") ACE_TEXT ("read %d bytes\n"), this->id (), n)); } // Set the write pointer in the stack buffer message_block.wr_ptr (n); // // STACK PROCESSING OR MESSAGE CONSOLIDATION // // PRE: data in buffer is aligned && message_block.length() > 0 if (this->incoming_message_stack_.top (q_data) != -1 && q_data->missing_data_ == TAO_MISSING_DATA_UNDEFINED) { // // MESSAGE CONSOLIDATION // // Partial message on incoming_message_stack_ needs to be // consolidated. The message header could not be parsed so far // and therefor the message size is unknown yet. Consolidating // the message destroys the memory alignment of succeeding // messages sharing the buffer, for that reason consolidation // and stack based processing are mutial exclusive. if (this->messaging_object ()->consolidate_node (q_data, message_block) == -1) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_parse_data, ") ACE_TEXT ("error consolidating message from input buffer\n"), this->id () )); } return -1; } // Complete message are to be enqueued and later processed if (q_data->missing_data_ == 0) { if (this->incoming_message_stack_.pop (q_data) == -1) { return -1; } if (this->consolidate_enqueue_message (q_data) == -1) { return -1; } } if (message_block.length () > 0 && this->handle_input_parse_extra_messages (message_block) == -1) { return -1; } // In any case try to process the enqueued messages if (this->process_queue_head (rh) == -1) { return -1; } } else { // // STACK PROCESSING (critical path) // // Process the first message in buffer on stack // (PRE: first message resides in aligned memory) Make a node of // the message-block.. TAO_Queued_Data qd (&message_block, this->orb_core_->transport_message_buffer_allocator ()); size_t mesg_length = 0; if (this->messaging_object ()->parse_next_message (message_block, qd, mesg_length) == -1 || (qd.missing_data_ == 0 && mesg_length > message_block.length ()) ) { // extracting message failed return -1; } // POST: qd.missing_data_ == 0 --> mesg_length <= message_block.length() // This prevents seeking rd_ptr behind the wr_ptr if (qd.missing_data_ != 0 || qd.more_fragments_ || qd.msg_type_ == TAO_PLUGGABLE_MESSAGE_FRAGMENT) { if (qd.missing_data_ == 0) { // Dealing with a fragment TAO_Queued_Data *nqd = TAO_Queued_Data::duplicate (qd); if (nqd == 0) { return -1; } // mark the end of message in new buffer char* end_mark = nqd->msg_block_->rd_ptr () + mesg_length; nqd->msg_block_->wr_ptr (end_mark); // move the read pointer forward in old buffer message_block.rd_ptr (mesg_length); // enqueue the message if (this->consolidate_enqueue_message (nqd) == -1) { return -1; } if (message_block.length () > 0 && this->handle_input_parse_extra_messages (message_block) == -1) { return -1; } // In any case try to process the enqueued messages if (this->process_queue_head (rh) == -1) { return -1; } } else if (qd.missing_data_ != TAO_MISSING_DATA_UNDEFINED) { // Incomplete message, must be the last one in buffer if (qd.missing_data_ != TAO_MISSING_DATA_UNDEFINED && qd.missing_data_ > message_block.space ()) { // Re-Allocate correct size on heap if (ACE_CDR::grow (qd.msg_block_, message_block.length () + qd.missing_data_) == -1) { return -1; } } TAO_Queued_Data *nqd = TAO_Queued_Data::duplicate (qd); if (nqd == 0) { return -1; } // move read-pointer to end of buffer message_block.rd_ptr (message_block.length()); this->incoming_message_stack_.push (nqd); } } else { // // critical path // // We cant process the message on stack right now. First we // have got to parse extra messages from message_block, // putting them into queue. When this is done we can return // to process this message, and notifying other threads to // process the messages in queue. char * end_marker = message_block.rd_ptr () + mesg_length; if (message_block.length () > mesg_length) { // There are more message in data stream to be parsed. // Safe the rd_ptr to restore later. char *rd_ptr_stack_mesg = message_block.rd_ptr (); // Skip parsed message, jump to next message in buffer // PRE: mesg_length <= message_block.length () message_block.rd_ptr (mesg_length); // Extract remaining messages and enqueue them for later // heap processing if (this->handle_input_parse_extra_messages (message_block) == -1) { return -1; } // correct the end_marker end_marker = message_block.rd_ptr (); // Restore rd_ptr message_block.rd_ptr (rd_ptr_stack_mesg); } // The following if-else has been copied from // process_queue_head(). While process_queue_head() // processes message on heap, here we will process a message // on stack. // Now that we have one message on stack to be processed, // check whether we have one more message in the queue... if (this->incoming_message_queue_.queue_length () > 0) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_input_parse_data, ") ACE_TEXT ("notify reactor\n"), this->id ())); } const int retval = this->notify_reactor (); if (retval == 1) { // Let the class know that it doesn't need to resume the // handle.. rh.set_flag (TAO_Resume_Handle::TAO_HANDLE_LEAVE_SUSPENDED); } else if (retval < 0) return -1; } else { // As there are no further messages in queue just resume // the handle. Set the flag incase someone had reset the flag.. rh.set_flag (TAO_Resume_Handle::TAO_HANDLE_RESUMABLE); } // PRE: incoming_message_queue is empty if (this->process_parsed_messages (&qd, rh) == -1) { return -1; } // move the rd_ptr tp position of end_marker message_block.rd_ptr (end_marker); } } // Now that all cases have been processed, there might be kept some data // in buffer that needs to be safed for next "handle_input" invocations. if (message_block.length () > 0) { if (this->partial_message_ == 0) { this->allocate_partial_message_block (); } if (this->partial_message_ != 0 && this->partial_message_->copy (message_block.rd_ptr (), message_block.length ()) == 0) { message_block.rd_ptr (message_block.length ()); } else { return -1; } } return 0; }

int TAO_Transport::handle_input_parse_extra_messages (  ACE_Message_Block &  message_block  )  [private]

Is invoked by handle_input_parse_data. Parses all messages remaining in message_block. Definition at line 1628 of file Transport.cpp. References consolidate_enqueue_message(), TAO_Pluggable_Messaging::extract_next_message(), incoming_message_stack_, ACE_Message_Block::length(), messaging_object(), TAO_Queued_Data::missing_data_, and TAO::Incoming_Message_Stack::push(). Referenced by handle_input_parse_data(). { // store buffer status of last extraction: -1 parse error, 0 // incomplete message header in buffer, 1 complete messages header // parsed int buf_status = 0; TAO_Queued_Data *q_data = 0; // init // parse buffer until all messages have been extracted, consolidate // and enqueue complete messages, if the last message being parsed // has missin data, it is stays on top of incoming_message_stack. while (message_block.length () > 0 && (buf_status = this->messaging_object ()->extract_next_message (message_block, q_data)) != -1 && q_data != 0) // paranoid check { if (q_data->missing_data_ == 0) { if (this->consolidate_enqueue_message (q_data) == -1) { return -1; } } else // incomplete message read, probably the last message in buffer { // can not fail this->incoming_message_stack_.push (q_data); } q_data = 0; // reset } // while if (buf_status == -1) { return -1; } return 0; }

int TAO_Transport::handle_output (  void   )

Callback method to reactively drain the outgoing data queue. Definition at line 453 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, drain_queue(), LM_DEBUG, and TAO_debug_level. Referenced by TAO_Block_Flushing_Strategy::flush_message(), TAO_Block_Flushing_Strategy::flush_transport(), and TAO_Connection_Handler::handle_output_eh(). { if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_output\n"), this->id ())); } // The flushing strategy (potentially via the Reactor) wants to send // more data, first check if there is a current message that needs // more sending... int const retval = this->drain_queue (); if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::handle_output, ") ACE_TEXT ("drain_queue returns %d/%d\n"), this->id (), retval, errno)); } // Any errors are returned directly to the Reactor return retval; }

int TAO_Transport::handle_timeout (  const ACE_Time_Value &  current_time, const void *  act )

Parameters: current_time  The current time as reported from the Reactor act  The Asynchronous Completion Token. Currently it is interpreted as follows: If the ACT is the address of this->current_deadline_ the queueing timeout has expired and the queue should start flushing. Returns: Returns 0 if there are no problems, -1 if there is an error Todo: In the future this function could be used to expire messages (oneways) that have been sitting for too long on the queue. Definition at line 775 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, current_deadline_, flush_timer_pending(), TAO_ORB_Core::flushing_strategy(), LM_DEBUG, orb_core(), reset_flush_timer(), TAO_Flushing_Strategy::schedule_output(), and TAO_debug_level. Referenced by TAO_Transport_Timer::handle_timeout(). { if (TAO_debug_level > 6) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - TAO_Transport[%d]::handle_timeout, ") ACE_TEXT ("timer expired\n"), this->id ())); } /// This is the only legal ACT in the current configuration.... if (act != &this->current_deadline_) { return -1; } if (this->flush_timer_pending ()) { // The timer is always a oneshot timer, so mark is as not // pending. this->reset_flush_timer (); TAO_Flushing_Strategy *flushing_strategy = this->orb_core ()->flushing_strategy (); (void) flushing_strategy->schedule_output (this); } return 0; }

ACE_INLINE void TAO_Transport::id (  size_t  id  )

Definition at line 92 of file Transport.inl. { this->id_ = id; }

ACE_INLINE size_t TAO_Transport::id (  void   )  const

Set and Get the identifier for this transport instance. If not set, this will return an integer representation of the this pointer for the instance on which it's called. Definition at line 86 of file Transport.inl. Referenced by TAO::Transport_Cache_Manager::bind_i(), TAO_Connection_Handler::close_connection_eh(), TAO_IIOP_Connector::complete_connection(), TAO_Connector::connect(), TAO::Transport_Cache_Manager::find_transport(), TAO_Connection_Handler::handle_input_internal(), TAO_Connector::parallel_connect(), TAO_GIOP_Message_Lite::parse_reply(), TAO_GIOP_Message_Base::process_reply_message(), TAO::Transport_Cache_Manager::purge(), TAO_GIOP_Utils::read_buffer(), TAO_GIOP_Message_Base::send_close_connection(), TAO_GIOP_Message_Lite::send_error(), TAO_GIOP_Message_Base::send_error(), TAO_GIOP_Message_Lite::send_reply_exception(), TAO_Connector::wait_for_connection_completion(), and TAO_Leader_Follower::wait_for_event(). { return this->id_; }

bool TAO_Transport::idle_after_reply (  void   )

Request is sent and the reply is received. Idle the transport now. Definition at line 239 of file Transport.cpp. References TAO_Transport_Mux_Strategy::idle_after_reply(), and tms(). { return this->tms ()->idle_after_reply (); }

bool TAO_Transport::idle_after_send (  void   )

Request has been just sent, but the reply is not received. Idle the transport now. Definition at line 233 of file Transport.cpp. References TAO_Transport_Mux_Strategy::idle_after_send(), and tms(). { return this->tms ()->idle_after_send (); }

ACE_INLINE bool TAO_Transport::is_connected (  void   )  const

Is this transport really connected. Definition at line 164 of file Transport.inl. References ACE_GUARD_RETURN, and is_connected_. Referenced by TAO_IIOP_Connector::complete_connection(), TAO_Connector::connect(), TAO::Synch_Oneway_Invocation::remote_oneway(), and TAO_Connector::wait_for_connection_completion(). { ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, false); return this->is_connected_; }

ACE_INLINE CORBA::Boolean TAO_Transport::is_tcs_set (   )  const

Return true if the tcs has been set. Definition at line 152 of file Transport.inl. References tcs_set_. { return tcs_set_; }

int TAO_Transport::make_idle (  void   )

Cache management. Definition at line 429 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, LM_DEBUG, TAO::Transport_Cache_Manager::make_idle(), TAO_debug_level, and transport_cache_manager(). Referenced by TAO_Exclusive_TMS::idle_after_reply(), TAO_Muxed_TMS::idle_after_send(), TAO_IIOP_Connection_Handler::process_listen_point_list(), and TAO::Profile_Transport_Resolver::~Profile_Transport_Resolver(). { if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::make_idle\n"), this->id ())); } return this->transport_cache_manager ().make_idle (this->cache_map_entry_); }

virtual int TAO_Transport::messaging_init (  CORBA::Octet  major, CORBA::Octet  minor )  [pure virtual]

Initialising the messaging object. This would be used by the connector side. On the acceptor side the connection handler would take care of the messaging objects. Implemented in TAO_IIOP_Transport.

virtual TAO_Pluggable_Messaging* TAO_Transport::messaging_object (  void   )  [pure virtual]

Return the messaging object that is used to format the data that needs to be sent. Implemented in TAO_IIOP_Transport. Referenced by allocate_partial_message_block(), consolidate_enqueue_message(), consolidate_process_message(), format_queue_message(), TAO_On_Demand_Fragmentation_Strategy::fragment(), generate_locate_request(), generate_request_header(), handle_input_parse_data(), handle_input_parse_extra_messages(), out_stream(), process_parsed_messages(), and send_connection_closed_notifications_i().

int TAO_Transport::notify_reactor (  void   )  [private]

Definition at line 2277 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, event_handler_i(), TAO_Wait_Strategy::is_registered(), LM_DEBUG, ACE_Reactor::notify(), orb_core(), TAO_ORB_Core::reactor(), and TAO_debug_level. Referenced by handle_input_parse_data(), and process_queue_head(). { if (!this->ws_->is_registered ()) { return 0; } ACE_Event_Handler *eh = this->event_handler_i (); // Get the reactor associated with the event handler ACE_Reactor *reactor = this->orb_core ()->reactor (); if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::notify_reactor, ") ACE_TEXT ("notify to Reactor\n"), this->id ())); } // Send a notification to the reactor... const int retval = reactor->notify (eh, ACE_Event_Handler::READ_MASK); if (retval < 0 && TAO_debug_level > 2) { // @@todo: need to think about what is the action that // we can take when we get here. ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::notify_reactor, ") ACE_TEXT ("notify to the reactor failed..\n"), this->id ())); } return 1; }

ACE_INLINE void TAO_Transport::opened_as (  TAO::Connection_Role   )

Definition at line 51 of file Transport.inl. References opening_connection_role_. { this->opening_connection_role_ = role; }

ACE_INLINE TAO::Connection_Role TAO_Transport::opened_as (  void   )  const

Methods dealing with the role of the connection, e.g., CLIENT or SERVER. See CORBA 2.6 Specification, Section 15.5.1 for origin of definitions. Definition at line 45 of file Transport.inl. References opening_connection_role_. Referenced by TAO::Wait_On_LF_No_Upcall::can_process_upcalls(), TAO_Connector::connect(), and TAO_IIOP_Connection_Handler::open(). { return this->opening_connection_role_; }

void TAO_Transport::operator= (  const TAO_Transport &   )  [private]

ACE_INLINE TAO_ORB_Core * TAO_Transport::orb_core (  void   )  const

Access the ORB that owns this connection. Definition at line 14 of file Transport.inl. Referenced by TAO::Wait_On_LF_No_Upcall::can_process_upcalls(), TAO_Connection_Handler::close_connection_eh(), drain_queue(), TAO::Transport_Cache_Manager::find_transport(), TAO_Reactive_Flushing_Strategy::flush_message(), TAO_Leader_Follower_Flushing_Strategy::flush_message(), TAO_Reactive_Flushing_Strategy::flush_transport(), TAO_Leader_Follower_Flushing_Strategy::flush_transport(), generate_request_header(), TAO_IIOP_Transport::generate_request_header(), handle_timeout(), TAO::Nested_Upcall_Guard::Nested_Upcall_Guard(), notify_reactor(), post_open(), send_asynchronous_message_i(), send_reply_message_i(), send_synchronous_message_i(), TAO_IIOP_Transport::set_bidir_context_info(), TAO_Wait_On_Read::wait(), TAO_Wait_On_Reactor::wait(), TAO_Wait_On_Leader_Follower::wait(), and TAO::Nested_Upcall_Guard::~Nested_Upcall_Guard(). { return this->orb_core_; }

TAO_OutputCDR & TAO_Transport::out_stream (  void   )

Accessor for the output CDR stream. Definition at line 2364 of file Transport.cpp. References messaging_object(), and TAO_Pluggable_Messaging::out_stream(). Referenced by TAO::LocateRequest_Invocation::invoke(), and TAO::Synch_Oneway_Invocation::remote_oneway(). { return this->messaging_object ()->out_stream (); }

bool TAO_Transport::post_connect_hook (  void   )  [virtual]

Hooks that can be overridden in concrete transports. These hooks are invoked just after connection establishment (or after a connection is fetched from cache). The return value signifies whether the invoker should proceed with post connection establishment activities. Protocols like SSLIOP need this to verify whether connections already established have valid certificates. There are no pre_connect_hooks () since the transport doesn't exist before a connection establishment. :-) Note: The methods are not made const with a reason. Definition at line 287 of file Transport.cpp. Referenced by TAO_Connector::connect(). { return true; }

bool TAO_Transport::post_open (  size_t  id  )

Perform all the actions when this transport get opened. Definition at line 2370 of file Transport.cpp. References ACE_ERROR, ACE_GUARD_RETURN, ACE_TEXT, close_connection(), TAO_ORB_Core::flushing_strategy(), is_connected_, LM_ERROR, orb_core(), purge_entry(), queue_is_empty_i(), TAO_Wait_Strategy::register_handler(), TAO_Flushing_Strategy::schedule_output(), TAO_debug_level, and wait_strategy(). Referenced by TAO_IIOP_Connection_Handler::open(). { this->id_ = id; { ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, false); this->is_connected_ = true; } // When we have data in our outgoing queue schedule ourselves // for output if (this->queue_is_empty_i ()) return true; // If the wait strategy wants us to be registered with the reactor // then we do so. If registeration is required and it succeeds, // #REFCOUNT# becomes two. if (this->wait_strategy ()->register_handler () == 0) { TAO_Flushing_Strategy *flushing_strategy = this->orb_core ()->flushing_strategy (); (void) flushing_strategy->schedule_output (this); } else { // Registration failures. // Purge from the connection cache, if we are not in the cache, this // just does nothing. (void) this->purge_entry (); // Close the handler. (void) this->close_connection (); if (TAO_debug_level > 0) ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::post_connect , ") ACE_TEXT ("could not register the transport ") ACE_TEXT ("in the reactor.\n"), this->id ())); return false; } return true; }

int TAO_Transport::process_parsed_messages (  TAO_Queued_Data *  qd, TAO_Resume_Handle &  rh )  [protected]

Process the message by sending it to the higher layers of the ORB. Definition at line 2101 of file Transport.cpp. References ACE_DEBUG, ACE_ERROR, ACE_TEXT, TAO_Pluggable_Messaging::discard_fragmented_message(), LM_DEBUG, LM_ERROR, messaging_object(), TAO_Queued_Data::missing_data_, TAO_Queued_Data::msg_type_, TAO_Pluggable_Messaging::process_reply_message(), TAO_Pluggable_Messaging::process_request_message(), TAO_Resume_Handle::resume_handle(), TAO_debug_level, TAO_PLUGGABLE_MESSAGE_CANCELREQUEST, TAO_PLUGGABLE_MESSAGE_CLOSECONNECTION, TAO_PLUGGABLE_MESSAGE_LOCATEREPLY, TAO_PLUGGABLE_MESSAGE_LOCATEREQUEST, TAO_PLUGGABLE_MESSAGE_MESSAGERROR, TAO_PLUGGABLE_MESSAGE_REPLY, TAO_PLUGGABLE_MESSAGE_REQUEST, and TAO_Pluggable_Message_Type. Referenced by consolidate_process_message(), handle_input_parse_data(), and process_queue_head(). { if (TAO_debug_level > 7) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_parsed_messages, ") ACE_TEXT ("entering (missing data == %d)\n"), this->id(), qd->missing_data_)); } // Get the <message_type> that we have received const TAO_Pluggable_Message_Type t = qd->msg_type_; // int result = 0; if (t == TAO_PLUGGABLE_MESSAGE_CLOSECONNECTION) { if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_parsed_messages, ") ACE_TEXT ("received CloseConnection message - %m\n"), this->id())); // Return a "-1" so that the next stage can take care of // closing connection and the necessary memory management. return -1; } else if (t == TAO_PLUGGABLE_MESSAGE_REQUEST || t == TAO_PLUGGABLE_MESSAGE_LOCATEREQUEST) { // Let us resume the handle before we go ahead to process the // request. This will open up the handle for other threads. rh.resume_handle (); if (this->messaging_object ()->process_request_message ( this, qd) == -1) { // Return a "-1" so that the next stage can take care of // closing connection and the necessary memory management. return -1; } } else if (t == TAO_PLUGGABLE_MESSAGE_REPLY || t == TAO_PLUGGABLE_MESSAGE_LOCATEREPLY) { rh.resume_handle (); TAO_Pluggable_Reply_Params params (this); if (this->messaging_object ()->process_reply_message (params, qd) == -1) { if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_parsed_messages, ") ACE_TEXT ("error in process_reply_message - %m\n"), this->id ())); return -1; } } else if (t == TAO_PLUGGABLE_MESSAGE_CANCELREQUEST) { // The associated request might be incomplpete residing // fragmented in messaging object. We must make sure the // resources allocated by fragments are released. if (this->messaging_object ()->discard_fragmented_message (qd) == -1) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_parsed_messages, ") ACE_TEXT ("error processing CancelRequest\n"), this->id ())); } } // We are not able to cancel requests being processed already; // this is declared as optional feature by CORBA, and TAO does // not support this currently. // Just continue processing, CancelRequest does not mean to cut // off the connection. } else if (t == TAO_PLUGGABLE_MESSAGE_MESSAGERROR) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_parsed_messages, ") ACE_TEXT ("received MessageError, closing connection\n"), this->id ())); } return -1; } // If not, just return back.. return 0; }

int TAO_Transport::process_queue_head (  TAO_Resume_Handle &  rh  )  [private]

Definition at line 2206 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, TAO_Incoming_Message_Queue::dequeue_head(), incoming_message_queue_, LM_DEBUG, notify_reactor(), process_parsed_messages(), TAO_Incoming_Message_Queue::queue_length(), TAO_Queued_Data::release(), TAO_Resume_Handle::set_flag(), and TAO_debug_level. Referenced by handle_input(), and handle_input_parse_data(). { if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_queue_head, %d enqueued\n"), this->id (), this->incoming_message_queue_.queue_length () )); } // See if message in queue ... if (this->incoming_message_queue_.queue_length () > 0) { // Get the message on the head of the queue.. TAO_Queued_Data *qd = this->incoming_message_queue_.dequeue_head (); if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_queue_head, ") ACE_TEXT ("the size of the queue is [%d]\n"), this->id (), this->incoming_message_queue_.queue_length())); } // Now that we have pulled out out one message out of the queue, // check whether we have one more message in the queue... if (this->incoming_message_queue_.queue_length () > 0) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::process_queue_head, ") ACE_TEXT ("notify reactor\n"), this->id ())); } const int retval = this->notify_reactor (); if (retval == 1) { // Let the class know that it doesn't need to resume the // handle.. rh.set_flag (TAO_Resume_Handle::TAO_HANDLE_LEAVE_SUSPENDED); } else if (retval < 0) return -1; } else { // As we are ready to process the last message just resume // the handle. Set the flag incase someone had reset the flag.. rh.set_flag (TAO_Resume_Handle::TAO_HANDLE_RESUMABLE); } // Process the message... if (this->process_parsed_messages (qd, rh) == -1) { return -1; } // Delete the Queued_Data.. TAO_Queued_Data::release (qd); return 0; } return 1; }

bool TAO_Transport::provide_blockable_handler (  TAO::Connection_Handler_Set &  handlers  )

Called by the cache when the ORB is shuting down. Parameters: handlers  The TAO_Connection_Handler_Set into which the transport should place its handler if the transport has RW strategy on. Returns: true indicates a handler was added to the handler set. false indocates that the transport did not have a blockable handler that could be added. Definition at line 219 of file Transport.cpp. References add_reference(), TAO::Connection_Handler_Set, ACE_Unbounded_Set< T >::insert(), TAO_Wait_Strategy::non_blocking(), and opening_connection_role_. { if (this->ws_->non_blocking () || this->opening_connection_role_ == TAO::TAO_SERVER_ROLE) return false; (void) this->add_reference (); h.insert (this->connection_handler_i ()); return true; }

void TAO_Transport::provide_handler (  TAO::Connection_Handler_Set &  handlers  )

Added event handler to the handlers set. Called by the cache when the cache is closing. Parameters: handlers  The TAO_Connection_Handler_Set into which the transport should place its handler Definition at line 211 of file Transport.cpp. References add_reference(), TAO::Connection_Handler_Set, and ACE_Unbounded_Set< T >::insert(). { (void) this->add_reference (); handlers.insert (this->connection_handler_i ()); }

int TAO_Transport::purge_entry (  void   )

Cache management. Definition at line 423 of file Transport.cpp. References TAO::Transport_Cache_Manager::purge_entry(), and transport_cache_manager(). Referenced by TAO_Connection_Handler::close_connection_eh(), TAO_IIOP_Connector::complete_connection(), TAO_Connector::connect(), post_open(), recache_transport(), and ~TAO_Transport(). { return this->transport_cache_manager ().purge_entry (this->cache_map_entry_); }

ACE_INLINE void TAO_Transport::purging_order (  unsigned long  value  )

Definition at line 76 of file Transport.inl. References purging_order_. { // This should only be called by the Transport Cache Manager when // it is holding it's lock. // The transport should still be here since the cache manager still // has a reference to it. this->purging_order_ = value; }

ACE_INLINE unsigned long TAO_Transport::purging_order (  void   )  const

Get and Set the purging order. The purging strategy uses the set version to set the purging order. Definition at line 70 of file Transport.inl. References purging_order_. Referenced by TAO_LRU_Connection_Purging_Strategy::update_item(). { return this->purging_order_; }

ACE_INLINE int TAO_Transport::queue_is_empty (  void   )

Check if there are messages pending in the queue. Returns: 1 if the queue is empty Definition at line 98 of file Transport.inl. References ACE_GUARD_RETURN, and queue_is_empty_i(). Referenced by TAO_Reactive_Flushing_Strategy::flush_transport(), TAO_Leader_Follower_Flushing_Strategy::flush_transport(), and TAO_Block_Flushing_Strategy::flush_transport(). { ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, -1); return this->queue_is_empty_i (); }

int TAO_Transport::queue_is_empty_i (  void   )  [private]

Check if there are messages pending in the queue. This version assumes that the lock is already held. Use with care! Returns: 1 if the queue is empty Definition at line 715 of file Transport.cpp. Referenced by post_open(), queue_is_empty(), and TAO_Block_Flushing_Strategy::schedule_output(). { return (this->head_ == 0); }

int TAO_Transport::queue_message_i (  const ACE_Message_Block *  message_block  )  [protected]

Queue a message for message_block. Definition at line 1308 of file Transport.cpp. References ACE_NEW_RETURN, and TAO_Queued_Message::push_back(). Referenced by format_queue_message(), and send_asynchronous_message_i(). { TAO_Queued_Message *queued_message = 0; ACE_NEW_RETURN (queued_message, TAO_Asynch_Queued_Message (message_block, this->orb_core_, 0, 1), -1); queued_message->push_back (this->head_, this->tail_); return 0; }

int TAO_Transport::recache_transport (  TAO_Transport_Descriptor_Interface *  desc  )

Recache ourselves in the cache. Todo: Ideally the following should be inline. purge_entry has a return value, use it Definition at line 412 of file Transport.cpp. References TAO::Transport_Cache_Manager::cache_transport(), purge_entry(), and transport_cache_manager(). Referenced by TAO_IIOP_Connection_Handler::process_listen_point_list(). { // First purge our entry this->purge_entry (); // Then add ourselves to the cache return this->transport_cache_manager ().cache_transport (desc, this); }

virtual ssize_t TAO_Transport::recv (  char *  buffer, size_t  len, const ACE_Time_Value *  timeout = 0 )  [pure virtual]

Read len bytes from into buf. This method serializes on handler_lock_, guaranteeing that only thread can execute it on the same instance concurrently. Parameters: buffer  ORB allocated buffer where the data should be @ The ACE_Time_Value *s is just a place holder for now. It is not clear this this is the best place to specify this. The actual timeout values will be kept in the Policies. Implemented in TAO_IIOP_Transport. Referenced by handle_input_missing_data(), handle_input_parse_data(), TAO_GIOP_Utils::read_buffer(), and TAO_GIOP_Utils::read_bytes_input().

ACE_INLINE size_t TAO_Transport::recv_buffer_size (  void   )  const

Accessor to recv_buffer_size_. Definition at line 181 of file Transport.inl. { return this->recv_buffer_size_; }

int TAO_Transport::register_handler (  void   )  [virtual]

Register the handler with the reactor. Register the handler with the reactor. This method is used by the Wait_On_Reactor strategy. The transport must register its event handler with the ORB's Reactor. Todo: I think this method is pretty much useless, the connections are *always* registered with the Reactor, except in thread-per-connection mode. In that case putting the connection in the Reactor would produce unpredictable results anyway. Definition at line 299 of file Transport.cpp. References ACE_DEBUG, ACE_GUARD_RETURN, ACE_TEXT, event_handler_i(), TAO_Wait_Strategy::is_registered(), LM_DEBUG, ACE_Event_Handler::reactor(), TAO_ORB_Core::reactor(), ACE_Reactor::register_handler(), and TAO_debug_level. Referenced by TAO_Wait_On_Reactor::register_handler(), TAO_Wait_On_Leader_Follower::register_handler(), and TAO_Wait_On_Leader_Follower::sending_request(). { if (TAO_debug_level > 4) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::register_handler\n"), this->id ())); } ACE_Reactor * const r = this->orb_core_->reactor (); // @@note: This should be okay since the register handler call will // not make a nested call into the transport. ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, false); if (r == this->event_handler_i ()->reactor ()) { return 0; } // Set the flag in the Connection Handler and in the Wait Strategy // @@Maybe we should set these flags after registering with the // reactor. What if the registration fails??? this->ws_->is_registered (true); // Register the handler with the reactor return r->register_handler (this->event_handler_i (), ACE_Event_Handler::READ_MASK); }

ACE_Event_Handler::Reference_Count TAO_Transport::remove_reference (  void   )

Initialising the messaging object. This would be used by the connector side. On the acceptor side the connection handler would take care of the messaging objects. Definition at line 2358 of file Transport.cpp. References event_handler_i(), and ACE_Event_Handler::remove_reference(). Referenced by TAO_Connection_Handler::close_handler(), TAO::Cache_IntId::operator=(), TAO::Transport_Cache_Manager::purge(), TAO_Asynch_Reply_Dispatcher_Base::transport(), TAO::Cache_IntId::~Cache_IntId(), TAO::Profile_Transport_Resolver::~Profile_Transport_Resolver(), TAO_Asynch_Reply_Dispatcher_Base::~TAO_Asynch_Reply_Dispatcher_Base(), and TAO_Thread_Per_Connection_Handler::~TAO_Thread_Per_Connection_Handler(). { return this->event_handler_i ()->remove_reference (); }

void TAO_Transport::report_invalid_event_handler (  const char *  caller  )  [private]

Print out error messages if the event handler is not valid. Definition at line 1106 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, ACE_TEXT_CHAR_TO_TCHAR, LM_DEBUG, and TAO_debug_level. { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::report_invalid_event_handler") ACE_TEXT ("(%s) no longer associated with handler [tag=%d]\n"), this->id (), ACE_TEXT_CHAR_TO_TCHAR (caller), this->tag_)); } }

ACE_INLINE void TAO_Transport::reset_flush_timer (  void   )  [private]

The flush timer expired or was explicitly cancelled, mark it as not pending Definition at line 114 of file Transport.inl. References current_deadline_, and flush_timer_id_. Referenced by drain_queue_i(), and handle_timeout(). { this->flush_timer_id_ = -1; this->current_deadline_ = ACE_Time_Value::zero; }

int TAO_Transport::schedule_output_i (  void   )  [private]

Schedule handle_output() callbacks. Definition at line 722 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, event_handler_i(), ACE_Reactor::find_handler(), ACE_Event_Handler::get_handle(), LM_DEBUG, ACE_Event_Handler::reactor(), ACE_Event_Handler::remove_reference(), ACE_Reactor::schedule_wakeup(), and TAO_debug_level. Referenced by TAO_Reactive_Flushing_Strategy::schedule_output(), and TAO_Leader_Follower_Flushing_Strategy::schedule_output(). { ACE_Event_Handler *eh = this->event_handler_i (); ACE_Reactor *reactor = eh->reactor (); // Check to see if our event handler is still registered with the // reactor. It's possible for another thread to have run close_connection() // since we last used the event handler. ACE_Event_Handler * const found = reactor->find_handler (eh->get_handle ()); if (found != eh) { if(TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, "TAO (%P|%t) - Transport[%d]::schedule_output_i " "event handler not found in reactor, returning -1\n", this->id ())); } if (found) { found->remove_reference (); } return -1; } found->remove_reference (); if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::schedule_output_i\n"), this->id ())); } return reactor->schedule_wakeup (eh, ACE_Event_Handler::WRITE_MASK); }

virtual ssize_t TAO_Transport::send (  iovec *  iov, int  iovcnt, size_t &  bytes_transferred, const ACE_Time_Value *  timeout = 0 )  [pure virtual]

Write the complete Message_Block chain to the connection. This method serializes on handler_lock_, guaranteeing that only thread can execute it on the same instance concurrently. Often the implementation simply forwards the arguments to the underlying ACE_Svc_Handler class. Using the code factored out into ACE. Be careful with protocols that perform non-trivial transformations of the data, such as SSLIOP or protocols that compress the stream. Parameters: iov  contains the data that must be sent. timeout  is the maximum time that the application is willing to wait for the data to be sent, useful in platforms that implement timed writes. The timeout value is obtained from the policies set by the application. bytes_transferred  should return the total number of bytes successfully transferred before the connection blocked. This is required because in some platforms and/or protocols multiple system calls may be required to send the chain of message blocks. The first few calls can work successfully, but the final one can fail or signal a flow control situation (via EAGAIN). In this case the ORB expects the function to return -1, errno to be appropriately set and this argument to return the number of bytes already on the OS I/O subsystem. This call can also fail if the transport instance is no longer associated with a connection (e.g., the connection handler closed down). In that case, it returns -1 and sets errno to ENOENT. Implemented in TAO_IIOP_Transport. Referenced by drain_queue_helper().

int TAO_Transport::send_asynchronous_message_i (  TAO_Stub *  stub, const ACE_Message_Block *  message_block, ACE_Time_Value *  max_wait_time )  [private]

Send an asynchronous message, i.e. do not block until the message is on the wire Definition at line 1161 of file Transport.cpp. References ACE_DEBUG, ACE_ERROR, ACE_GUARD_RETURN, ACE_TEXT, check_buffering_constraints_i(), ACE_Message_Block::cont(), ETIME, EWOULDBLOCK, TAO_Flushing_Strategy::flush_transport(), TAO_ORB_Core::flushing_strategy(), ACE_Message_Block::length(), LM_DEBUG, LM_ERROR, TAO::Transport_Queueing_Strategy::must_queue(), orb_core(), queue_message_i(), TAO_Flushing_Strategy::schedule_output(), send_message_block_chain_i(), ssize_t, TAO_debug_level, ACE_Message_Block::total_length(), and TAO_Stub::transport_queueing_strategy(). Referenced by send_message_shared_i(). { // Let's figure out if the message should be queued without trying // to send first: bool try_sending_first = true; const bool queue_empty = (this->head_ == 0); if (!queue_empty) { try_sending_first = false; } else if (stub->transport_queueing_strategy ().must_queue (queue_empty)) { try_sending_first = false; } if (try_sending_first) { ssize_t n = 0; size_t byte_count = 0; // ... in this case we must try to send the message first ... const size_t total_length = message_block->total_length (); if (TAO_debug_level > 6) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_asynchronous_message_i, ") ACE_TEXT ("trying to send the message (ml = %d)\n"), this->id (), total_length)); } // @@ I don't think we want to hold the mutex here, however if // we release it we need to recheck the status of the transport // after we return... once I understand the final form for this // code I will re-visit this decision n = this->send_message_block_chain_i (message_block, byte_count, max_wait_time); if (n == -1) { // ... if this is just an EWOULDBLOCK we must schedule the // message for later, if it is ETIME we still have to send // the complete message, because cutting off the message at // this point will destroy the synchronization with the // server ... if (errno != EWOULDBLOCK && errno != ETIME) { if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_asynchronous_message_i, ") ACE_TEXT ("fatal error in ") ACE_TEXT ("send_message_block_chain_i - %m\n"), this->id ())); } return -1; } } // ... let's figure out if the complete message was sent ... if (total_length == byte_count) { // Done, just return. Notice that there are no allocations // or copies up to this point (though some fancy calling // back and forth). // This is the common case for the critical path, it should // be fast. return 0; } if (TAO_debug_level > 6) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_asynchronous_message_i, ") ACE_TEXT ("partial send %d / %d bytes\n"), this->id (), byte_count, total_length)); } // ... part of the data was sent, need to figure out what piece // of the message block chain must be queued ... while (message_block != 0 && message_block->length () == 0) { message_block = message_block->cont (); } // ... at least some portion of the message block chain should // remain ... } // ... either the message must be queued or we need to queue it // because it was not completely sent out ... if (TAO_debug_level > 6) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_asynchronous_message_i, ") ACE_TEXT ("message is queued\n"), this->id ())); } if (this->queue_message_i(message_block) == -1) { if (TAO_debug_level > 0) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_asynchronous_message_i, ") ACE_TEXT ("cannot queue message for ") ACE_TEXT (" - %m\n"), this->id ())); return -1; } // ... if the queue is full we need to activate the output on the // queue ... bool must_flush = false; const bool constraints_reached = this->check_buffering_constraints_i (stub, must_flush); // ... but we also want to activate it if the message was partially // sent.... Plus, when we use the blocking flushing strategy the // queue is flushed as a side-effect of 'schedule_output()' TAO_Flushing_Strategy *flushing_strategy = this->orb_core ()->flushing_strategy (); if (constraints_reached || try_sending_first) { (void) flushing_strategy->schedule_output (this); } if (must_flush) { typedef ACE_Reverse_Lock<ACE_Lock> TAO_REVERSE_LOCK; TAO_REVERSE_LOCK reverse (*this->handler_lock_); ACE_GUARD_RETURN (TAO_REVERSE_LOCK, ace_mon, reverse, -1); (void) flushing_strategy->flush_transport (this); } return 0; }

void TAO_Transport::send_connection_closed_notifications (  void   )

Notify all the components inside a Transport when the underlying connection is closed. Definition at line 1118 of file Transport.cpp. References ACE_GUARD, TAO_Transport_Mux_Strategy::connection_closed(), send_connection_closed_notifications_i(), and tms(). Referenced by TAO_Connection_Handler::close_connection_eh(). { { ACE_MT (ACE_GUARD (ACE_Lock, guard, *this->handler_lock_)); this->send_connection_closed_notifications_i (); } this->tms ()->connection_closed (); }

void TAO_Transport::send_connection_closed_notifications_i (  void   )  [private]

Assume the lock is held. Definition at line 1130 of file Transport.cpp. References cleanup_queue_i(), messaging_object(), and TAO_Pluggable_Messaging::reset(). Referenced by send_connection_closed_notifications(). { this->cleanup_queue_i (); this->messaging_object ()->reset (); }

virtual int TAO_Transport::send_message (  TAO_OutputCDR &  stream, TAO_Stub *  stub = 0, int  message_semantics = TAO_Transport::TAO_TWOWAY_REQUEST, ACE_Time_Value *  max_time_wait = 0 )  [pure virtual]

Once the ORB is prepared to receive a reply (see send_request() above), and all the arguments have been marshaled the CDR stream must be 'formatted', i.e. the message_size field in the GIOP header can finally be set to the proper value. Implemented in TAO_IIOP_Transport. Referenced by TAO_On_Demand_Fragmentation_Strategy::fragment(), TAO_GIOP_Message_Lite::make_send_locate_reply(), TAO_GIOP_Message_Base::make_send_locate_reply(), TAO_GIOP_Message_Lite::process_request(), TAO_GIOP_Message_Base::process_request(), TAO_ServerRequest::send_cached_reply(), TAO_ServerRequest::send_no_exception_reply(), TAO_GIOP_Message_Lite::send_reply_exception(), TAO_GIOP_Message_Base::send_reply_exception(), TAO_ServerRequest::tao_send_reply(), and TAO_ServerRequest::tao_send_reply_exception().

int TAO_Transport::send_message_block_chain (  const ACE_Message_Block *  message_block, size_t &  bytes_transferred, ACE_Time_Value *  max_wait_time = 0 )

Send a message block chain,. Definition at line 490 of file Transport.cpp. References ACE_GUARD_RETURN, and send_message_block_chain_i(). Referenced by TAO_GIOP_Message_Base::send_close_connection(), TAO_GIOP_Message_Lite::send_error(), and TAO_GIOP_Message_Base::send_error(). { ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, -1); return this->send_message_block_chain_i (mb, bytes_transferred, max_wait_time); }

int TAO_Transport::send_message_block_chain_i (  const ACE_Message_Block *  message_block, size_t &  bytes_transferred, ACE_Time_Value *  max_wait_time )

Send a message block chain, assuming the lock is held. Definition at line 502 of file Transport.cpp. References drain_queue_i(), TAO_Synch_Queued_Message::message_length(), TAO_Queued_Message::push_back(), TAO_Queued_Message::remove_from_list(), and ACE_Message_Block::total_length(). Referenced by send_asynchronous_message_i(), and send_message_block_chain(). { size_t const total_length = mb->total_length (); // We are going to block, so there is no need to clone // the message block. TAO_Synch_Queued_Message synch_message (mb, this->orb_core_); synch_message.push_back (this->head_, this->tail_); int const n = this->drain_queue_i (); if (n == -1) { synch_message.remove_from_list (this->head_, this->tail_); return -1; // Error while sending... } else if (n == 1) { bytes_transferred = total_length; return 1; // Empty queue, message was sent.. } // Remove the temporary message from the queue... synch_message.remove_from_list (this->head_, this->tail_); bytes_transferred = total_length - synch_message.message_length (); return 0; }

int TAO_Transport::send_message_shared (  TAO_Stub *  stub, int  message_semantics, const ACE_Message_Block *  message_block, ACE_Time_Value *  max_wait_time )  [virtual]

Sent the contents of message_block. Parameters: stub  The object reference used for this operation, useful to obtain the current policies. message_semantics  If this is set to TAO_TWO_REQUEST this method will block until the operation is completely written on the wire. If it is set to other values this operation could return. message_block  The CDR encapsulation of the GIOP message that must be sent. The message may consist of multiple Message Blocks chained through the cont() field. max_wait_time  The maximum time that the operation can block, used in the implementation of timeouts. Reimplemented in TAO_IIOP_Transport. Definition at line 261 of file Transport.cpp. References ACE_GUARD_RETURN, close_connection(), and send_message_shared_i(). { int result = 0; { ACE_GUARD_RETURN (ACE_Lock, ace_mon, *this->handler_lock_, -1); result = this->send_message_shared_i (stub, message_semantics, message_block, max_wait_time); } if (result == -1) { this->close_connection (); } return result; }

int TAO_Transport::send_message_shared_i (  TAO_Stub *  stub, int  message_semantics, const ACE_Message_Block *  message_block, ACE_Time_Value *  max_wait_time )  [protected]

Implement send_message_shared() assuming the handler_lock_ is held. Definition at line 1138 of file Transport.cpp. References send_asynchronous_message_i(), send_reply_message_i(), send_synchronous_message_i(), TAO_ONEWAY_REQUEST, TAO_REPLY, and TAO_TWOWAY_REQUEST. Referenced by send_message_shared(), and TAO_IIOP_Transport::send_message_shared(). { switch (message_semantics) { case TAO_Transport::TAO_TWOWAY_REQUEST: return this->send_synchronous_message_i (message_block, max_wait_time); case TAO_Transport::TAO_REPLY: return this->send_reply_message_i (message_block, max_wait_time); case TAO_Transport::TAO_ONEWAY_REQUEST: return this->send_asynchronous_message_i (stub, message_block, max_wait_time); } return -1; }

int TAO_Transport::send_reply_message_i (  const ACE_Message_Block *  message_block, ACE_Time_Value *  max_wait_time )  [private]

Send a reply message, i.e. do not block until the message is on the wire, but just return after adding them to the queue. Definition at line 630 of file Transport.cpp. References ACE_DEBUG, ACE_TEXT, TAO_Synch_Queued_Message::clone(), TAO_Queued_Message::destroy(), TAO_ORB_Core::flushing_strategy(), LM_DEBUG, orb_core(), TAO_Queued_Message::push_back(), TAO_Queued_Message::remove_from_list(), TAO_Flushing_Strategy::schedule_output(), send_synch_message_helper_i(), and TAO_debug_level. Referenced by send_message_shared_i(). { // Dont clone now.. We could be sent in one shot! TAO_Synch_Queued_Message synch_message (mb, this->orb_core_); synch_message.push_back (this->head_, this->tail_); int const n = this->send_synch_message_helper_i (synch_message, max_wait_time); if (n == -1 || n == 1) { return n; } if (TAO_debug_level > 3) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_reply_message_i, ") ACE_TEXT ("preparing to add to queue before leaving \n"), this->id ())); } // Till this point we shouldn't have any copying and that is the // point anyway. Now, remove the node from the list synch_message.remove_from_list (this->head_, this->tail_); // Clone the node that we have. TAO_Queued_Message *msg = synch_message.clone (this->orb_core_->transport_message_buffer_allocator ()); // Stick it in the queue msg->push_back (this->head_, this->tail_); TAO_Flushing_Strategy *flushing_strategy = this->orb_core ()->flushing_strategy (); int result = flushing_strategy->schedule_output (this); if (result == -1) { if (TAO_debug_level > 5) { ACE_DEBUG ((LM_DEBUG, "TAO (%P|%t) - Transport[%d]::send_reply_" "message_i dequeuing msg due to schedule_output " "failure\n", this->id ())); } msg->remove_from_list (this->head_, this->tail_); msg->destroy (); } return 1; }

virtual int TAO_Transport::send_request (  TAO_Stub *  stub, TAO_ORB_Core *  orb_core, TAO_OutputCDR &  stream, int  message_semantics, ACE_Time_Value *  max_time_wait )  [pure virtual]

Preparing the ORB to receive the reply only once the request is completely sent opens the system to some subtle race conditions: suppose the ORB is running in a multi-threaded configuration, thread A makes a request while thread B is using the Reactor to process all incoming requests. Thread A could be implemented as follows: 1) send the request 2) setup the ORB to receive the reply 3) wait for the request but in this case thread B may receive the reply between step (1) and (2), and drop it as an invalid or unexpected message. Consequently the correct implementation is: 1) setup the ORB to receive the reply 2) send the request 3) wait for the reply The following method encapsulates this idiom. Todo: This is generic code, it should be factored out into the Transport class. Implemented in TAO_IIOP_Transport. Referenced by TAO::Remote_Invocation::send_message().

int TAO_Transport::send_synch_message_helper_i (  TAO_Synch_Queued_Message &  s, ACE_Time_Value *  max_wait_time )  [private]

A helper method used by send_synchronous_message_i() and send_reply_message_i(). Reusable code that could be used by both the methods. Definition at line 690 of file Transport.cpp. References TAO_Synch_Queued_Message::all_data_sent(), drain_queue_i(), and TAO_Queued_Message::remove_from_list(). Referenced by send_reply_message_i(), and send_synchronous_message_i(). { // @@todo: Need to send timeouts for writing.. int const n = this->drain_queue_i (); if (n == -1) { synch_message.remove_from_list (this->head_, this->tail_); return -1; // Error while sending... } else if (n == 1) { return 1; // Empty queue, message was sent.. } if (synch_message.all_data_sent ()) { return 1; } return 0; }

int TAO_Transport::send_synchronous_message_i (  const ACE_Message_Block *  message_block, ACE_Time_Value *  max_wait_time )  [private]

Send a synchronous message, i.e. block until the message is on the wire Definition at line 538 of file Transport.cpp. References ACE_ERROR, ACE_GUARD_RETURN, ACE_NEW_RETURN, ACE_TEXT, TAO_Synch_Queued_Message::current_block(), ETIME, TAO_Flushing_Strategy::flush_message(), TAO_ORB_Core::flushing_strategy(), LM_ERROR, orb_core(), TAO_Queued_Message::push_back(), TAO_Queued_Message::push_front(), TAO_Queued_Message::remove_from_list(), TAO_Flushing_Strategy::schedule_output(), send_synch_message_helper_i(), and TAO_debug_level. Referenced by send_message_shared_i(). { // We are going to block, so there is no need to clone // the message block. TAO_Synch_Queued_Message synch_message (mb, this->orb_core_); // Push synch_message on to the back of the queue. synch_message.push_back (this->head_, this->tail_); int const n = this->send_synch_message_helper_i (synch_message, max_wait_time); if (n == -1 || n == 1) { return n; } // @todo: Check for timeouts! // if (max_wait_time != 0 && errno == ETIME) return -1; TAO_Flushing_Strategy *flushing_strategy = this->orb_core ()->flushing_strategy (); (void) flushing_strategy->schedule_output (this); // Release the mutex, other threads may modify the queue as we // block for a long time writing out data. int result; { typedef ACE_Reverse_Lock<ACE_Lock> TAO_REVERSE_LOCK; TAO_REVERSE_LOCK reverse (*this->handler_lock_); ACE_GUARD_RETURN (TAO_REVERSE_LOCK, ace_mon, reverse, -1); result = flushing_strategy->flush_message (this, &synch_message, max_wait_time); } if (result == -1) { synch_message.remove_from_list (this->head_, this->tail_); if (errno == ETIME) { if (this->head_ == &synch_message) { // This is a timeout, there is only one nasty case: the // message has been partially sent! We simply cannot take // the message out of the queue, because that would corrupt // the connection. // // What we do is replace the queued message with an // asynchronous message, that contains only what remains of // the timed out request. If you think about sending // CancelRequests in this case: there is no much point in // doing that: the receiving ORB would probably ignore it, // and figuring out the request ID would be a bit of a // nightmare. // synch_message.remove_from_list (this->head_, this->tail_); TAO_Queued_Message *queued_message = 0; ACE_NEW_RETURN (queued_message, TAO_Asynch_Queued_Message ( synch_message.current_block (), this->orb_core_, 0, 1), -1); queued_message->push_front (this->head_, this->tail_); } } if (TAO_debug_level > 0) { ACE_ERROR ((LM_ERROR, ACE_TEXT ("TAO (%P|%t) - Transport[%d]::send_synchronous_message_i, ") ACE_TEXT ("error while flushing message - %m\n"), this->id ())); } return -1; } return 1; }

ACE_INLINE size_t TAO_Transport::sent_byte_count (  void   )  const

Accessor to sent_byte_count_. Definition at line 187 of file Transport.inl. References sent_byte_count_. { return this->sent_byte_count_; }

TAO_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE CORBA::ULong TAO_Transport::tag (  void   )  const

Return the protocol tag. The OMG assigns unique tags (a 32-bit unsigned number) to each protocol. New protocol tags can be obtained free of charge from the OMG, check the documents in corbafwd.h for more details. Definition at line 8 of file Transport.inl. { return this->tag_; }

int TAO_Transport::tear_listen_point_list (  TAO_InputCDR &  cdr  )  [virtual]

Extracts the list of listen points from the cdr stream. The list would have the protocol specific details of the ListenPoints Reimplemented in TAO_IIOP_Transport. Definition at line 255 of file Transport.cpp. References ACE_NOTSUP_RETURN. Referenced by TAO_GIOP_Message_Generator_Parser_12::process_bidir_context(). { ACE_NOTSUP_RETURN (-1); }

ACE_INLINE TAO_Transport_Mux_Strategy * TAO_Transport::tms (  void   )  const

Get the TAO_Tranport_Mux_Strategy used by this object. The role of the TAO_Transport_Mux_Strategy is described in more detail in that class' documentation. Enough is to say that the class is used to control how many threads can have pending requests over the same connection. Multiplexing multiple threads over the same connection conserves resources and is almost required for AMI, but having only one pending request per connection is more efficient and reduces the possibilities of priority inversions. Definition at line 20 of file Transport.inl. Referenced by idle_after_reply(), idle_after_send(), TAO::LocateRequest_Invocation_Adapter::invoke(), TAO::Invocation_Adapter::invoke_remote_i(), TAO_GIOP_Message_Lite::parse_reply(), TAO_GIOP_Message_Base::process_reply_message(), and send_connection_closed_notifications(). { return tms_; }

TAO::Transport_Cache_Manager & TAO_Transport::transport_cache_manager (  void   )  [private]

Helper method that returns the Transport Cache Manager. Definition at line 2316 of file Transport.cpp. References TAO_ORB_Core::lane_resources(), and TAO_Thread_Lane_Resources::transport_cache(). Referenced by make_idle(), purge_entry(), recache_transport(), and update_transport(). { return this->orb_core_->lane_resources ().transport_cache (); }

int TAO_Transport::update_transport (  void   )

Cache management. Definition at line 442 of file Transport.cpp. References transport_cache_manager(), and TAO::Transport_Cache_Manager::update_entry(). Referenced by TAO_Connection_Handler::handle_input_internal(), TAO_Connection_Handler::handle_output_eh(), and TAO_Connection_Handler::svc_i(). { return this->transport_cache_manager ().update_entry (this->cache_map_entry_); }

ACE_INLINE TAO_Wait_Strategy * TAO_Transport::wait_strategy (  void   )  const

Return the TAO_Wait_Strategy used by this object. The role of the TAO_Wait_Strategy is described in more detail in that class' documentation. Enough is to say that the ORB can wait for a reply blocking on read(), using the Reactor to wait for multiple events concurrently or using the Leader/Followers protocol. Definition at line 27 of file Transport.inl. Referenced by TAO_Connection_Handler::close_connection_eh(), TAO_IIOP_Connector::complete_connection(), TAO_Connector::connect(), TAO::Transport_Cache_Manager::find_transport(), TAO_Connection_Handler::handle_input_eh(), TAO_IIOP_Connection_Handler::open(), and post_open(). { return this->ws_; }

ACE_INLINE void TAO_Transport::wchar_translator (  TAO_Codeset_Translator_Base *   )

CodeSet negotiation - Set the wchar codeset translator factory. Definition at line 144 of file Transport.inl. References tcs_set_. { this->wchar_translator_ = tf; this->tcs_set_ = 1; }

ACE_INLINE TAO_Codeset_Translator_Base * TAO_Transport::wchar_translator (  void   )  const

CodeSet Negotiation - Get the wchar codeset translator factory. Definition at line 131 of file Transport.inl. { return this->wchar_translator_; }

---

Friends And Related Function Documentation

friend class TAO_Block_Flushing_Strategy [friend]

This class needs priviledged access to queue_is_empty_i() drain_queue_i() Definition at line 785 of file Transport.h.

friend class TAO_Leader_Follower_Flushing_Strategy [friend]

Definition at line 803 of file Transport.h.

friend class TAO_Reactive_Flushing_Strategy [friend]

These classes need privileged access to: schedule_output_i() cancel_output_i() Definition at line 802 of file Transport.h.

friend class TAO_Thread_Per_Connection_Handler [friend]

Needs priveleged access to event_handler_i () Definition at line 807 of file Transport.h.

---

Member Data Documentation

int TAO_Transport::bidirectional_flag_ [protected]

Have we sent any info on bidirectional information or have we received any info regarding making the connection served by this transport bidirectional. The flag is used as follows: + We dont want to send the bidirectional context info more than once on the connection. Why? Waste of marshalling and demarshalling time on the client. + On the server side -- once a client that has established the connection asks the server to use the connection both ways, we *dont* want the server to pack service info to the client. That is not allowed. We need a flag to prevent such a things from happening. The value of this flag will be 0 if the client sends info and 1 if the server receives the info. Definition at line 958 of file Transport.h. Referenced by bidirectional_flag().

TAO::Transport_Cache_Manager::HASH_MAP_ENTRY* TAO_Transport::cache_map_entry_ [protected]

Our entry in the cache. We don't own this. It is here for our convenience. We cannot just change things around. Definition at line 930 of file Transport.h. Referenced by cache_map_entry().

TAO_Codeset_Translator_Base* TAO_Transport::char_translator_ [private]

Additional member values required to support codeset translation. @Phil, I think it would be nice if we could think of a way to do the following. We have been trying to use the transport for marking about translator factories and such! IMHO this is a wrong encapulation ie. trying to populate the transport object with these details. We should probably have a class something like TAO_Message_Property or TAO_Message_Translator or whatever (I am sure you get the idea) and encapsulate all these details. Coupling these seems odd. if I have to be more cynical we can move this to the connection_handler and it may more sense with the DSCP stuff around there. Do you agree? Definition at line 1033 of file Transport.h.

ACE_Time_Value TAO_Transport::current_deadline_ [protected]

The queue will start draining no later than if* the deadline is Definition at line 975 of file Transport.h. Referenced by check_buffering_constraints_i(), handle_timeout(), and reset_flush_timer().

CORBA::Boolean TAO_Transport::first_request_ [private]

First_request_ is true until the first request is sent or received. This is necessary since codeset context information is necessary only on the first request. After that, the translators are fixed for the life of the connection. Definition at line 1045 of file Transport.h. Referenced by first_request_sent(), and generate_request_header().

long TAO_Transport::flush_timer_id_ [protected]

The timer ID. Definition at line 978 of file Transport.h. Referenced by check_buffering_constraints_i(), flush_timer_pending(), and reset_flush_timer().

ACE_Lock* TAO_Transport::handler_lock_ [mutable, protected]

This is an ACE_Lock that gets initialized from TAO_ORB_Core::resource_factory()->create_cached_connection_lock(). This way, one can use a lock appropriate for the type of system, i.e., a null lock for single-threaded systems, and a real lock for multi-threaded systems. Definition at line 992 of file Transport.h. Referenced by ~TAO_Transport().

TAO_Queued_Message* TAO_Transport::head_ [protected]

Implement the outgoing data queue. Definition at line 963 of file Transport.h.

size_t TAO_Transport::id_ [protected]

A unique identifier for the transport. This never *never* changes over the lifespan, so we don't have to worry about locking it. HINT: Protocol-specific transports that use connection handler might choose to set this to the handle for their connection. Definition at line 1002 of file Transport.h.

TAO_Incoming_Message_Queue TAO_Transport::incoming_message_queue_ [protected]

Queue of the consolidated, incoming messages.. Definition at line 967 of file Transport.h. Referenced by consolidate_enqueue_message(), handle_input_parse_data(), and process_queue_head().

TAO::Incoming_Message_Stack TAO_Transport::incoming_message_stack_ [protected]

Stack of incoming fragments, consolidated messages are going to be enqueued in "incoming_message_queue_" Definition at line 971 of file Transport.h. Referenced by handle_input(), handle_input_missing_data(), handle_input_parse_data(), and handle_input_parse_extra_messages().

bool TAO_Transport::is_connected_ [protected]

Is this transport really connected or not. In case of oneways with SYNC_NONE Policy we don't wait until the connection is ready and we buffer the requests in this transport until the connection is ready Definition at line 1016 of file Transport.h. Referenced by is_connected(), post_open(), and ~TAO_Transport().

TAO::Connection_Role TAO_Transport::opening_connection_role_ [protected]

Definition at line 960 of file Transport.h. Referenced by opened_as(), and provide_blockable_handler().

TAO_ORB_Core* const TAO_Transport::orb_core_ [protected]

Global orbcore resource. Definition at line 926 of file Transport.h. Referenced by TAO_GIOP_Message_Lite::process_locate_request(), TAO_GIOP_Message_Base::process_locate_request(), TAO_GIOP_Message_Lite::process_request(), and TAO_GIOP_Message_Base::process_request().

ACE_Message_Block* TAO_Transport::partial_message_ [private]

Holds the partial GIOP message (if there is one). Definition at line 1048 of file Transport.h. Referenced by allocate_partial_message_block(), and handle_input_parse_data().

unsigned long TAO_Transport::purging_order_ [protected]

Used by the LRU, LFU and FIFO Connection Purging Strategies. Definition at line 1005 of file Transport.h. Referenced by purging_order().

size_t TAO_Transport::recv_buffer_size_ [protected]

Size of the buffer received. Definition at line 1008 of file Transport.h.

size_t TAO_Transport::sent_byte_count_ [protected]

Number of bytes sent. Definition at line 1011 of file Transport.h. Referenced by drain_queue_helper(), drain_queue_i(), and sent_byte_count().

CORBA::ULong const TAO_Transport::tag_ [protected]

IOP protocol tag. Definition at line 923 of file Transport.h.

TAO_Queued_Message* TAO_Transport::tail_ [protected]

Definition at line 964 of file Transport.h.

CORBA::Boolean TAO_Transport::tcs_set_ [private]

The tcs_set_ flag indicates that negotiation has occured and so the translators are correct, since a null translator is valid if both ends are using the same codeset, whatever that codeset might be. Definition at line 1039 of file Transport.h. Referenced by char_translator(), is_tcs_set(), and wchar_translator().

TAO_Transport_Mux_Strategy* TAO_Transport::tms_ [protected]

Strategy to decide whether multiple requests can be sent over the same connection or the connection is exclusive for a request. Definition at line 934 of file Transport.h.

TAO_Transport_Timer TAO_Transport::transport_timer_ [protected]

The adapter used to receive timeout callbacks from the Reactor. Definition at line 981 of file Transport.h.

TAO_Codeset_Translator_Base* TAO_Transport::wchar_translator_ [private]

Definition at line 1034 of file Transport.h.

TAO_Wait_Strategy* TAO_Transport::ws_ [protected]

Strategy for waiting for the reply after sending the request. Definition at line 937 of file Transport.h.

---

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

• Transport.h
• Transport.cpp
• Transport.inl

---