TAO_UIPMC_Transport Class Reference

Specialization of the base TAO_Transport class to handle the MIOP protocol. More...

#include <UIPMC_Transport.h>

Inheritance diagram for TAO_UIPMC_Transport:

[legend]Collaboration diagram for TAO_UIPMC_Transport:

[legend]List of all members.

Overridden Template Methods
These are implementations of template methods declared by TAO_Transport.
virtual int	send_request (TAO_Stub *stub, TAO_ORB_Core *orb_core, TAO_OutputCDR &stream, int message_semantics, ACE_Time_Value *max_wait_time)
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)
virtual int	messaging_init (CORBA::Octet major, CORBA::Octet minor)
	Initialising the messaging object.
virtual ACE_Event_Handler *	event_handler_i (void)
virtual TAO_Connection_Handler *	connection_handler_i (void)
virtual TAO_Pluggable_Messaging *	messaging_object (void)
virtual ssize_t	send (iovec *iov, int iovcnt, size_t &bytes_transferred, const ACE_Time_Value *max_wait_time)
	Write the complete Message_Block chain to the connection.
virtual ssize_t	recv (char *buf, size_t len, const ACE_Time_Value *s=0)
	Read len bytes from into buf.
virtual int	register_handler (void)
Public Member Functions
	TAO_UIPMC_Transport (TAO_UIPMC_Connection_Handler *handler, TAO_ORB_Core *orb_core, CORBA::Boolean flag)
	Constructor.
	~TAO_UIPMC_Transport (void)
	Default destructor.
virtual int	handle_input (TAO_Resume_Handle &rh, ACE_Time_Value *max_wait_time=0, int block=0)
	Look for the documentation in Transport.h.
Private Member Functions
int	process_message (void)
	Process the message that we have read.
void	write_unique_id (TAO_OutputCDR &miop_hdr, unsigned long unique)
	Construct and write a unique ID to the MIOP header.
Private Attributes
TAO_UIPMC_Connection_Handler *	connection_handler_
TAO_Pluggable_Messaging *	messaging_object_
	Our messaging object.

---

Detailed Description

Specialization of the base TAO_Transport class to handle the MIOP protocol.

Definition at line 51 of file UIPMC_Transport.h.

---

Constructor & Destructor Documentation

TAO_UIPMC_Transport::TAO_UIPMC_Transport (  TAO_UIPMC_Connection_Handler *  handler, TAO_ORB_Core *  orb_core, CORBA::Boolean  flag )

Constructor. Definition at line 71 of file UIPMC_Transport.cpp. References ACE_NEW, and MIOP_MAX_DGRAM_SIZE. : TAO_Transport (IOP::TAG_UIPMC, orb_core) , connection_handler_ (handler) , messaging_object_ (0) { // Use the normal GIOP object ACE_NEW (this->messaging_object_, TAO_GIOP_Message_Base (orb_core, this, MIOP_MAX_DGRAM_SIZE)); // Replace the default wait strategy with our own // since we don't support waiting on anything. delete this->ws_; ACE_NEW (this->ws_, TAO_UIPMC_Wait_Never (this)); }

TAO_UIPMC_Transport::~TAO_UIPMC_Transport (  void   )

Default destructor. Definition at line 92 of file UIPMC_Transport.cpp. { delete this->messaging_object_; }

---

Member Function Documentation

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

@TODO: These methods IMHO should have more meaningful names. The names seem to indicate nothing. Implements TAO_Transport. Definition at line 104 of file UIPMC_Transport.cpp. { return this->connection_handler_; }

ACE_Event_Handler * TAO_UIPMC_Transport::event_handler_i (  void   )  [protected, virtual]

@TODO: These methods IMHO should have more meaningful names. The names seem to indicate nothing. Implements TAO_Transport. Definition at line 98 of file UIPMC_Transport.cpp. { return this->connection_handler_; }

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

Look for the documentation in Transport.h. Reimplemented from TAO_Transport. Definition at line 433 of file UIPMC_Transport.cpp. References ACE_DEBUG, ACE_TEXT(), TAO_Transport_Mux_Strategy::connection_closed(), TAO_ORB_Core::input_cdr_dblock_allocator(), ACE_Message_Block::length(), LM_DEBUG, TAO_ORB_Core::locking_strategy(), ACE_CDR::mb_align(), ACE_OS::memset(), messaging_object(), MIOP_MAX_DGRAM_SIZE, TAO_Pluggable_Messaging::parse_next_message(), TAO_Transport::process_parsed_messages(), ACE_Message_Block::rd_ptr(), recv(), ACE_Message_Block::space(), ssize_t, TAO_debug_level, and ACE_Message_Block::wr_ptr(). { // If there are no messages then we can go ahead to read from the // handle for further reading.. // The buffer on the stack which will be used to hold the input // messages char buf [MIOP_MAX_DGRAM_SIZE]; #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); // Read the message into the message block that we have created on // the stack. ssize_t n = this->recv (message_block.rd_ptr (), message_block.space (), max_wait_time); // If there is an error return to the reactor.. if (n <= 0) { if (TAO_debug_level) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO: (%P|%t|%N|%l) recv returned error on transport %d after fault %p\n"), this->id (), ACE_TEXT ("handle_input_i ()\n"))); } if (n == -1) this->tms_->connection_closed (); return n; } // Set the write pointer in the stack buffer. message_block.wr_ptr (n); // Make a node of the message block.. TAO_Queued_Data qd (&message_block); size_t mesg_length; // Parse the incoming message for validity. The check needs to be // performed by the messaging objects. if (this->messaging_object ()->parse_next_message (message_block, qd, mesg_length) == -1) { if (TAO_debug_level) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO: (%P|%t|%N|%l) handle_input failed on transport %d after fault\n"), this->id () )); } return -1; } if (message_block.length () > mesg_length) { if (TAO_debug_level) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO: (%P|%t|%N|%l) handle_input failed on transport %d after fault\n"), this->id () )); } return -1; } // NOTE: We are not performing any queueing nor any checking for // missing data. We are assuming that ALL the data would be got in a // single read. // Process the message return this->process_parsed_messages (&qd, rh); }

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

Initialising the messaging object. Implements TAO_Transport. Definition at line 605 of file UIPMC_Transport.cpp. References TAO_Pluggable_Messaging::init(). { this->messaging_object_->init (major, minor); return 1; }

TAO_Pluggable_Messaging * TAO_UIPMC_Transport::messaging_object (  void   )  [protected, virtual]

@TODO: These methods IMHO should have more meaningful names. The names seem to indicate nothing. Implements TAO_Transport. Definition at line 110 of file UIPMC_Transport.cpp. Referenced by handle_input(). { return this->messaging_object_; }

int TAO_UIPMC_Transport::process_message (  void   )  [private]

Process the message that we have read.

ssize_t TAO_UIPMC_Transport::recv (  char *  buf, size_t  len, const ACE_Time_Value *  s = 0 )  [protected, virtual]

Read len bytes from into buf. Implements TAO_Transport. Definition at line 330 of file UIPMC_Transport.cpp. References ACE_CDR_BYTE_ORDER, ACE_DEBUG, ACE_INET_Addr::get_host_addr(), ACE_INET_Addr::get_port_number(), LM_DEBUG, TAO_UIPMC_Connection_Handler::mcast_dgram(), ACE_OS::memmove(), MIOP_FLAGS_OFFSET, MIOP_ID_CONTENT_OFFSET, MIOP_ID_LENGTH_OFFSET, miop_magic, MIOP_MAGIC_OFFSET, MIOP_MAX_LENGTH_ID, MIOP_MIN_HEADER_SIZE, ACE_SOCK_Dgram::recv(), ssize_t, ACE_CDR::swap_4(), and TAO_debug_level. Referenced by handle_input(). { ACE_INET_Addr from_addr; ssize_t n = this->connection_handler_->mcast_dgram ().recv (buf, len, from_addr); if (TAO_debug_level > 5) { ACE_DEBUG ((LM_DEBUG, "TAO_UIPMC_Transport::recv_i: received %d bytes from %s:%d\n", n, from_addr.get_host_addr (), from_addr.get_port_number ())); } // Make sure that we at least have a MIOP header. if (n < MIOP_MIN_HEADER_SIZE) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, "TAO_UIPMC_Transport::recv_i: packet of size %d is too small from %s:%d\n", n, from_addr.get_host_addr (), from_addr.get_port_number ())); } return 0; } // Check for MIOP magic bytes. if (buf[MIOP_MAGIC_OFFSET] != miop_magic [0] || buf[MIOP_MAGIC_OFFSET + 1] != miop_magic [1] || buf[MIOP_MAGIC_OFFSET + 2] != miop_magic [2] || buf[MIOP_MAGIC_OFFSET + 3] != miop_magic [3]) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, "TAO_UIPMC_Transport::recv_i: UIPMC packet didn't contain magic bytes.\n")); } return 0; } // Retrieve the byte order. // 0 = Big endian // 1 = Small endian CORBA::Octet byte_order = buf[MIOP_FLAGS_OFFSET] & 0x01; // Ignore the header version, other flags, packet length and number of packets. // Get the length of the ID. CORBA::ULong id_length; #if !defined (ACE_DISABLE_SWAP_ON_READ) if (byte_order == ACE_CDR_BYTE_ORDER) { id_length = *reinterpret_cast<ACE_CDR::ULong*> (&buf[MIOP_ID_LENGTH_OFFSET]); } else { ACE_CDR::swap_4 (&buf[MIOP_ID_LENGTH_OFFSET], reinterpret_cast<char*> (&id_length)); } #else id_length = *reinterpret_cast<ACE_CDR::ULong*> (&buf[MIOP_ID_LENGTH_OFFSET]); #endif /* ACE_DISABLE_SWAP_ON_READ */ // Make sure that the length field is legal. if (id_length > MIOP_MAX_LENGTH_ID || static_cast<ssize_t> (MIOP_ID_CONTENT_OFFSET + id_length) > n) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, "TAO_UIPMC_Transport::recv_i: Invalid ID length.\n")); } return 0; } // Trim off the header for now. ssize_t miop_header_size = (MIOP_ID_CONTENT_OFFSET + id_length + 7) & ~0x7; if (miop_header_size > n) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, "TAO_UIPMC_Transport::recv_i: MIOP packet not large enough for padding.\n")); } return 0; } n -= miop_header_size; ACE_OS::memmove (buf, buf + miop_header_size, n); return n; }

int TAO_UIPMC_Transport::register_handler (  void   )  [protected, virtual]

@TODO: These methods IMHO should have more meaningful names. The names seem to indicate nothing. Reimplemented from TAO_Transport. Definition at line 537 of file UIPMC_Transport.cpp. { // We never register register the handler with the reactor // as we never need to be informed about any incoming data, // assuming we only use one-ways. // If we would register and ICMP Messages would arrive, e.g // due to a not reachable server, we would get informed - as this // disturbs the general MIOP assumptions of not being // interested in any network failures, we ignore ICMP messages. return 0; }

ssize_t TAO_UIPMC_Transport::send (  iovec *  iov, int  iovcnt, size_t &  bytes_transferred, const ACE_Time_Value *  max_wait_time )  [protected, virtual]

Write the complete Message_Block chain to the connection. Implements TAO_Transport. Definition at line 150 of file UIPMC_Transport.cpp. References ACE_DEBUG, ACE_IOV_MAX, ACE_TEXT(), TAO_UIPMC_Connection_Handler::addr(), ACE_OutputCDR::current(), TAO_UIPMC_Connection_Handler::dgram(), ACE_INET_Addr::get_host_addr(), ACE_INET_Addr::get_port_number(), MIOP_Packet::iov, iovec::iov_base, iovec::iov_len, MIOP_Packet::iovcnt, MIOP_Packet::length, LM_DEBUG, MIOP_HEADER_SIZE, miop_magic, MIOP_MAX_DGRAM_SIZE, MIOP_MAX_FRAGMENTS, UIPMC_Message_Block_Data_Iterator::next_block(), ACE_Message_Block::rd_ptr(), ACE_SOCK_Dgram::send(), ssize_t, TAO_debug_level, TAO_ENCAP_BYTE_ORDER, ACE_Message_Block::wr_ptr(), ACE_OutputCDR::write_octet(), ACE_OutputCDR::write_octet_array(), ACE_OutputCDR::write_short(), ACE_OutputCDR::write_ulong(), and write_unique_id(). { const ACE_INET_Addr &addr = this->connection_handler_->addr (); bytes_transferred = 0; // Calculate the bytes to send. This value is only used for // error conditions to fake a good return. We do this for // semantic consistency with DIOP, and since errors aren't // handled correctly from send_i (our fault). If these // semantics are not desirable, the error handling problems // that need to be fixed can be found in // UIPMC_Connection_Handler::decr_refcount which will need to // deregister the connection handler from the UIPMC_Connector // cache. ssize_t bytes_to_send = 0; for (int i = 0; i < iovcnt; i++) bytes_to_send += iov[i].iov_len; MIOP_Packet fragments[MIOP_MAX_FRAGMENTS]; MIOP_Packet *current_fragment; int num_fragments = 1; UIPMC_Message_Block_Data_Iterator mb_iter (iov, iovcnt); // Initialize the first fragment current_fragment = &fragments[0]; current_fragment->iovcnt = 1; // The MIOP Header current_fragment->length = MIOP_HEADER_SIZE; // Go through all of the message blocks. while (mb_iter.next_block (MIOP_MAX_DGRAM_SIZE - current_fragment->length, current_fragment->iov[current_fragment->iovcnt])) { // Increment the length and iovcnt. current_fragment->length += current_fragment->iov[current_fragment->iovcnt].iov_len; current_fragment->iovcnt++; // Check if we've filled up this fragment or if we've run out of // iov entries. if (current_fragment->length == MIOP_MAX_DGRAM_SIZE || current_fragment->iovcnt == ACE_IOV_MAX) { // Make a new fragment. num_fragments++; // Check if too many fragments if (num_fragments > MIOP_MAX_FRAGMENTS) { // This is an error as we do not send more. // Silently drop the message but log an error. // Pluggable_Messaging::transport_message only // cares if it gets -1 or 0 so we can return a // partial length and it will think all has gone // well. if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\n\nTAO (%P|%t) ") ACE_TEXT ("UIPMC_Transport::send_i ") ACE_TEXT ("Message of size %d needs too many MIOP fragments (max is %d).\n") ACE_TEXT ("You may be able to increase ACE_MAX_DGRAM_SIZE.\n"), bytes_to_send, MIOP_MAX_FRAGMENTS)); } // Pretend it is o.k. See note by bytes_to_send calculation. bytes_transferred = bytes_to_send; return 1; } // Otherwise, initialize another fragment. current_fragment++; current_fragment->iovcnt = 1; // The MIOP Header current_fragment->length = MIOP_HEADER_SIZE; } } // Build a generic MIOP Header. // Allocate space on the stack for the header (add 8 to account for // the possibility of adjusting for alignment). char header_buffer[MIOP_HEADER_SIZE + 8]; TAO_OutputCDR miop_hdr (header_buffer, MIOP_HEADER_SIZE + 8); miop_hdr.write_octet_array (miop_magic, 4); // Magic miop_hdr.write_octet (0x10); // Version CORBA::Octet *flags_field = reinterpret_cast<CORBA::Octet *> (miop_hdr.current ()->wr_ptr ()); // Write flags octet: // Bit Description // 0 Endian // 1 Stop message flag (Assigned later) // 2 - 7 Set to 0 miop_hdr.write_octet (TAO_ENCAP_BYTE_ORDER); // Flags // Packet Length // NOTE: We can save pointers and write them later without byte swapping since // in CORBA, the sender chooses the endian. CORBA::UShort *packet_length = reinterpret_cast<CORBA::UShort *> (miop_hdr.current ()->wr_ptr ()); miop_hdr.write_short (0); // Packet number CORBA::ULong *packet_number = reinterpret_cast<CORBA::ULong *> (miop_hdr.current ()->wr_ptr ()); miop_hdr.write_ulong (0); // Number of packets field miop_hdr.write_ulong (num_fragments); // UniqueId ptrdiff_t unique_id = reinterpret_cast<ptrdiff_t> (iov); this->write_unique_id (miop_hdr, static_cast<unsigned long> (unique_id)); // Send the buffers. current_fragment = &fragments[0]; while (num_fragments > 0 && current_fragment->iovcnt > 1) { // Fill in the packet length header field. *packet_length = static_cast<CORBA::UShort> (current_fragment->length); // If this is the last fragment, set the stop message flag. if (num_fragments == 1) { *flags_field |= 0x02; } // Setup the MIOP header in the iov list. current_fragment->iov[0].iov_base = miop_hdr.current ()->rd_ptr (); current_fragment->iov[0].iov_len = MIOP_HEADER_SIZE; // Send the fragment. - Need to check for errors!! ssize_t rc = this->connection_handler_->dgram ().send (current_fragment->iov, current_fragment->iovcnt, addr); if (rc <= 0) { if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\n\nTAO (%P|%t) ") ACE_TEXT ("UIPMC_Transport::send") ACE_TEXT (" %p\n\n"), ACE_TEXT ("Error returned from transport:"))); } // Pretend it is o.k. See note by bytes_to_send calculation. bytes_transferred = bytes_to_send; return 1; } // Increment the number of bytes transferred, but don't // count the MIOP header that we added. bytes_transferred += rc - MIOP_HEADER_SIZE; if (TAO_debug_level > 0) { ACE_DEBUG ((LM_DEBUG, "TAO_UIPMC_Transport::send_i: sent %d bytes to %s:%d\n", rc, addr.get_host_addr (), addr.get_port_number ())); } // Go to the next fragment. (*packet_number)++; ++current_fragment; --num_fragments; } // Return total bytes transferred. return bytes_transferred; }

int TAO_UIPMC_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 )  [virtual]

@TODO: These methods IMHO should have more meaningful names. The names seem to indicate nothing. Implements TAO_Transport. Definition at line 571 of file UIPMC_Transport.cpp. References ACE_DEBUG, ACE_TEXT(), ACE_OutputCDR::begin(), TAO_Pluggable_Messaging::format_message(), LM_DEBUG, TAO_Transport::send_message_shared(), ssize_t, and TAO_debug_level. Referenced by send_request(). { // Format the message in the stream first if (this->messaging_object_->format_message (stream) != 0) return -1; // Strictly speaking, should not need to loop here because the // socket never gets set to a nonblocking mode ... some Linux // versions seem to need it though. Leaving it costs little. // This guarantees to send all data (bytes) or return an error. ssize_t n = this->send_message_shared (stub, message_semantics, stream.begin (), max_wait_time); if (n == -1) { if (TAO_debug_level) ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("TAO: (%P|%t|%N|%l) closing transport %d after fault %p\n"), this->id (), ACE_TEXT ("send_message ()\n"))); return -1; } return 1; }

int TAO_UIPMC_Transport::send_request (  TAO_Stub *  stub, TAO_ORB_Core *  orb_core, TAO_OutputCDR &  stream, int  message_semantics, ACE_Time_Value *  max_wait_time )  [virtual]

@TODO: These methods IMHO should have more meaningful names. The names seem to indicate nothing. Implements TAO_Transport. Definition at line 550 of file UIPMC_Transport.cpp. References send_message(), and TAO_Wait_Strategy::sending_request(). { if (this->ws_->sending_request (orb_core, message_semantics) == -1) return -1; if (this->send_message (stream, stub, message_semantics, max_wait_time) == -1) return -1; return 0; }

void TAO_UIPMC_Transport::write_unique_id (  TAO_OutputCDR &  miop_hdr, unsigned long  unique )  [private]

Construct and write a unique ID to the MIOP header. Definition at line 117 of file UIPMC_Transport.cpp. References MIOP_ID_DEFAULT_LENGTH, ACE_OutputCDR::write_octet_array(), and ACE_OutputCDR::write_ulong(). Referenced by send(). { // We currently construct a unique ID for each MIOP message by // concatenating the address of the buffer to a counter. We may // also need to use a MAC address or something more unique to // fully comply with the MIOP specification. static unsigned long counter = 1; // Don't worry about race conditions on counter, // since buffer addresses can't be the same if // this is being called simultaneously. CORBA::Octet unique_id[MIOP_ID_DEFAULT_LENGTH]; unique_id[0] = static_cast<CORBA::Octet> (unique & 0xff); unique_id[1] = static_cast<CORBA::Octet> ((unique & 0xff00) >> 8); unique_id[2] = static_cast<CORBA::Octet> ((unique & 0xff0000) >> 16); unique_id[3] = static_cast<CORBA::Octet> ((unique & 0xff000000) >> 24); unique_id[4] = static_cast<CORBA::Octet> (counter & 0xff); unique_id[5] = static_cast<CORBA::Octet> ((counter & 0xff00) >> 8); unique_id[6] = static_cast<CORBA::Octet> ((counter & 0xff0000) >> 16); unique_id[7] = static_cast<CORBA::Octet> ((counter & 0xff000000) >> 24); unique_id[8] = 0; unique_id[9] = 0; unique_id[10] = 0; unique_id[11] = 0; miop_hdr.write_ulong (MIOP_ID_DEFAULT_LENGTH); miop_hdr.write_octet_array (unique_id, MIOP_ID_DEFAULT_LENGTH); }

---

Member Data Documentation

TAO_UIPMC_Connection_Handler* TAO_UIPMC_Transport::connection_handler_ [private]

The connection service handler used for accessing lower layer communication protocols. Definition at line 122 of file UIPMC_Transport.h.

TAO_Pluggable_Messaging* TAO_UIPMC_Transport::messaging_object_ [private]

Our messaging object. Definition at line 125 of file UIPMC_Transport.h.

---

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

• UIPMC_Transport.h
• UIPMC_Transport.cpp

---