TAO_ECG_Simple_Mcast_EH Class Reference

Simple Event Handler for mcast messages. Listens for messages on a single mcast group. Useful in environments where event traffic is not separated into different groups. Calls handle_input (ACE_SOCK_Dgram_Mcast dgram) on a specified TAO_ECG_Dgram_Handler to inform it about message arrival. More...

#include <ECG_Simple_Mcast_EH.h>

Inheritance diagram for TAO_ECG_Simple_Mcast_EH:

[legend]Collaboration diagram for TAO_ECG_Simple_Mcast_EH:

[legend]List of all members.

Public Member Functions
virtual int	handle_input (ACE_HANDLE fd)
	TAO_ECG_Simple_Mcast_EH (TAO_ECG_Dgram_Handler *recv)
	Initialization and termination methods.
virtual	~TAO_ECG_Simple_Mcast_EH (void)
	Destructor.
int	open (const char *mcast_addr, const ACE_TCHAR *net_if=0)
virtual int	shutdown (void)
Private Attributes
ACE_SOCK_Dgram_Mcast	dgram_
TAO_ECG_Dgram_Handler *	receiver_
	We callback to this object when a message arrives.

---

Detailed Description

Simple Event Handler for mcast messages. Listens for messages on a single mcast group. Useful in environments where event traffic is not separated into different groups. Calls handle_input (ACE_SOCK_Dgram_Mcast dgram) on a specified TAO_ECG_Dgram_Handler to inform it about message arrival.

NOT THREAD-SAFE.

Definition at line 39 of file ECG_Simple_Mcast_EH.h.

---

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_ECG_Simple_Mcast_EH::TAO_ECG_Simple_Mcast_EH

(

TAO_ECG_Dgram_Handler *

recv

)

Initialization and termination methods.

Constructor. Messages received by this EH will be forwarded to the <recv>.

Definition at line 10 of file ECG_Simple_Mcast_EH.cpp.

References ACE_ASSERT.

  : receiver_ (recv)
{
  ACE_ASSERT (this->receiver_);
}

TAO_ECG_Simple_Mcast_EH::~TAO_ECG_Simple_Mcast_EH

(

void

)

[virtual]

Destructor.

Definition at line 16 of file ECG_Simple_Mcast_EH.cpp.

{
}

---

Member Function Documentation

int TAO_ECG_Simple_Mcast_EH::handle_input

(

ACE_HANDLE

fd

)

[virtual]

Main method - reactor callback. Notify <receiver_> that <dgram_> is ready for reading.

Reimplemented from ACE_Event_Handler.

Definition at line 93 of file ECG_Simple_Mcast_EH.cpp.

References TAO_ECG_Dgram_Handler::handle_input(), and receiver_.

{
  return this->receiver_->handle_input (this->dgram_);
}

int TAO_ECG_Simple_Mcast_EH::open	(	const char *	mcast_addr,
		const ACE_TCHAR *	net_if = 0
	)

Join the specified multicast group and register itself with the reactor. To insure proper resource clean up, if open () is successful, the user MUST call shutdown () when handler is no longer needed (and its reactor still exists).

Definition at line 21 of file ECG_Simple_Mcast_EH.cpp.

References ACE_ERROR_RETURN, ACE_NONBLOCK, ACE_SOCK::close(), dgram_, ACE_IPC_SAP::enable(), LM_ERROR, ACE_Event_Handler::reactor(), ACE_Event_Handler::READ_MASK, ACE_Reactor::register_handler(), and ACE_INET_Addr::set().

Referenced by TAO_ECG_Mcast_Gateway::init_handler().

{
  // Check that we haven't been closed already.
  if (!this->receiver_)
    return -1;

  if (mcast_addr == 0)
    return -1;

  ACE_INET_Addr mcast_group;
  if (mcast_group.set (mcast_addr) != 0)
    ACE_ERROR_RETURN ((LM_ERROR,
                       "Unable to open mcast handler: "
                       "error using specified address %s "
                       "in ACE_INET.set ().\n",
                       mcast_addr),
                      -1);

  if (this->dgram_.join (mcast_group, 1, net_if) != 0)
    ACE_ERROR_RETURN ((LM_ERROR,
                      "Unable to open mcast handler: error "
                      "joining to %s\n",
                       mcast_addr),
                      -1);

  (void) dgram_.enable(ACE_NONBLOCK);

  if (!this->reactor ()
      || 0 != this->reactor ()->register_handler (this->dgram_.get_handle (),
                                                  this,
                                                  ACE_Event_Handler::READ_MASK))
    {
      this->dgram_.close ();
      ACE_ERROR_RETURN ((LM_ERROR,
                         "Cannot register handler with reactor.\n"),
                        -1);
    }

  return 0;
}

int TAO_ECG_Simple_Mcast_EH::shutdown

(

void

)

[virtual]

TAO_ECG_Handler_Shutdown method. Unsubscribe from the reactor and close the datagram.

Implements TAO_ECG_Handler_Shutdown.

Definition at line 64 of file ECG_Simple_Mcast_EH.cpp.

References ACE_ERROR, ACE_SOCK::close(), dgram_, LM_ERROR, ACE_Event_Handler::READ_MASK, and receiver_.

{
  // Already shut down.
  if (!this->receiver_)
    return -1;

  int result = 0;
  if (this->reactor ())
    {
      result = this->reactor ()->remove_handler (this->dgram_.get_handle (),
                                                 ACE_Event_Handler::READ_MASK);
    }
  if (result != 0)
    ACE_ERROR ((LM_ERROR,
                "Unable to deregister handler from reactor "
                "on shutdown.\n"));

  result = this->dgram_.close ();
  if (result != 0)
    ACE_ERROR ((LM_ERROR,
                "Unable to close mcast receiving dgram "
                "on shutdown.\n"));

  this->receiver_ = 0;

  return result;
}

---

Member Data Documentation

ACE_SOCK_Dgram_Mcast TAO_ECG_Simple_Mcast_EH::dgram_ [private]

Definition at line 78 of file ECG_Simple_Mcast_EH.h.

Referenced by open(), and shutdown().

TAO_ECG_Dgram_Handler* TAO_ECG_Simple_Mcast_EH::receiver_ [private]

We callback to this object when a message arrives.

Definition at line 90 of file ECG_Simple_Mcast_EH.h.

Referenced by handle_input(), and shutdown().

---

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

• ECG_Simple_Mcast_EH.h
• ECG_Simple_Mcast_EH.cpp

---