TAO_RTEvent  3.0.0
Public Member Functions | Private Attributes | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for TAO_ECG_Simple_Mcast_EH:
Collaboration graph
[legend]

Public Member Functions

 TAO_ECG_Simple_Mcast_EH (TAO_ECG_Dgram_Handler *recv)
 Initialization and termination methods. More...
 
virtual ~TAO_ECG_Simple_Mcast_EH ()
 Destructor. More...
 
int open (const char *mcast_addr, const ACE_TCHAR *net_if=0)
 
virtual int shutdown ()
 
virtual int handle_input (ACE_HANDLE fd)
 
- Public Member Functions inherited from ACE_Event_Handler
virtual ~ACE_Event_Handler ()
 
virtual ACE_HANDLE get_handle () const
 
virtual void set_handle (ACE_HANDLE)
 
virtual int priority () const
 
virtual void priority (int priority)
 
virtual int handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)
 
virtual int handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
 
virtual int handle_timeout (const ACE_Time_Value &current_time, const void *act=0)
 
virtual int handle_exit (ACE_Process *)
 
virtual int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)
 
virtual int handle_signal (int signum, siginfo_t *=0, ucontext_t *=0)
 
virtual int resume_handler ()
 
virtual int handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)
 
virtual int handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)
 
virtual void reactor (ACE_Reactor *reactor)
 
virtual ACE_Reactorreactor () const
 
virtual ACE_Reactor_Timer_Interfacereactor_timer_interface () const
 
virtual Reference_Count add_reference ()
 
virtual Reference_Count remove_reference ()
 
Reference_Counting_Policyreference_counting_policy ()
 
- Public Member Functions inherited from TAO_ECG_Handler_Shutdown
virtual ~TAO_ECG_Handler_Shutdown ()
 

Private Attributes

ACE_SOCK_Dgram_Mcast dgram_
 
TAO_ECG_Dgram_Handlerreceiver_
 We callback to this object when a message arrives. More...
 

Additional Inherited Members

- Public Types inherited from ACE_Event_Handler
typedef long Reference_Count
 
- Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN read_adapter (void *event_handler)
 
static int register_stdin_handler (ACE_Event_Handler *eh, ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)
 
static int remove_stdin_handler (ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr)
 
- Public Attributes inherited from ACE_Event_Handler
 LO_PRIORITY
 
 HI_PRIORITY
 
 NULL_MASK
 
 READ_MASK
 
 WRITE_MASK
 
 EXCEPT_MASK
 
 ACCEPT_MASK
 
 CONNECT_MASK
 
 TIMER_MASK
 
 QOS_MASK
 
 GROUP_QOS_MASK
 
 SIGNAL_MASK
 
 ALL_EVENTS_MASK
 
 RWE_MASK
 
 DONT_CALL
 
 ACE_EVENT_HANDLER_NOT_RESUMED
 
 ACE_REACTOR_RESUMES_HANDLER
 
 ACE_APPLICATION_RESUMES_HANDLER
 
- Protected Types inherited from ACE_Event_Handler
typedef std::atomic< Reference_CountAtomic_Reference_Count
 
- Protected Member Functions inherited from ACE_Event_Handler
 ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY)
 
- Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count reference_count_
 

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.

Constructor & Destructor Documentation

◆ TAO_ECG_Simple_Mcast_EH()

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>.

◆ ~TAO_ECG_Simple_Mcast_EH()

TAO_ECG_Simple_Mcast_EH::~TAO_ECG_Simple_Mcast_EH ( )
virtual

Destructor.

Member Function Documentation

◆ handle_input()

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.

◆ open()

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).

◆ shutdown()

int TAO_ECG_Simple_Mcast_EH::shutdown ( )
virtual

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

Implements TAO_ECG_Handler_Shutdown.

Member Data Documentation

◆ dgram_

ACE_SOCK_Dgram_Mcast TAO_ECG_Simple_Mcast_EH::dgram_
private

◆ receiver_

TAO_ECG_Dgram_Handler* TAO_ECG_Simple_Mcast_EH::receiver_
private

We callback to this object when a message arrives.


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