OSM_Instance_IP Class Reference

IP4 Instance to monitor.It's an IP and a collection of events to supervise. More...

#include <osm_ag_ip.h>

Inheritance diagram for OSM_Instance_IP:

Inheritance graph
[legend]
Collaboration diagram for OSM_Instance_IP:

Collaboration graph
[legend]
List of all members.

Public Types

enum  { MAXIPLEN = MAXHOSTNAMELEN }

Public Member Functions

virtual ~OSM_Instance_IP ()
 Destructor.
int connect (void)
int check_conn_info (const ACE_TCHAR *conn_info)
int disconnect (const int force=0)
const ACE_TCHAR * ip () const
int open (const ACE_TCHAR *config_file, const ACE_TCHAR *idn_instance, const ACE_TCHAR *typ_instance, const ACE_TCHAR *con_info, OSM_AG_InsManager *InsManager, int *event_num)
virtual int close ()
ACE_TCHAR * idn_instance (void)
ACE_TCHAR * typ_instance (void)
OSM_AG_InsManagerins_manager ()
 Returns a pointer to the Instance Manager.
int connected ()
 Returns connection state.
void connected (const int connected)
 Sets connection state.

Detailed Description

IP4 Instance to monitor.It's an IP and a collection of events to supervise.

Definition at line 506 of file osm_ag_ip.h.


Member Function Documentation

int OSM_Instance_IP::connect ( void   )  [virtual]

Connection Function

Return values:
-1 in case of error.0 for success.

Reimplemented from OSM_Instance_Base.

Definition at line 646 of file osm_ag_ip.cpp.

int OSM_Instance_IP::check_conn_info ( const ACE_TCHAR *  conn_info  )  [virtual]

Checks if the connect information is correct for this type of instance.

Return values:
-1 in case of error.0 for success.

Reimplemented from OSM_Instance_Base.

Definition at line 605 of file osm_ag_ip.cpp.

References OSM_CfgManager::instance().

Here is the call graph for this function:

int OSM_Instance_IP::disconnect ( const int  force = 0  )  [virtual]

Disconnect from the current instance. Instance connection structure cleaning.

Return values:
-1 in case of error.0 for success.

Reimplemented from OSM_Instance_Base.

Definition at line 653 of file osm_ag_ip.cpp.

const ACE_TCHAR* OSM_Instance_IP::ip (  )  const [inline]

IP return function

Return values:
ip information of instance.

Definition at line 542 of file osm_ag_ip.h.

Referenced by OSM_ACT_IMAPGetOK::execute(), OSM_ACT_POPGetOK::execute(), OSM_ACT_SMTPGet220::execute(), OSM_ACT_SSHGetSSH::execute(), OSM_ACT_TelnetGetStr::execute(), OSM_ACT_FTPGet220::execute(), OSM_ACT_HTTPGet200::execute(), and OSM_ACT_LinuxPing::execute().

int OSM_Instance_Base::open ( const ACE_TCHAR *  config_file,
const ACE_TCHAR *  idn_instance,
const ACE_TCHAR *  typ_instance,
const ACE_TCHAR *  con_info,
OSM_AG_InsManager InsManager,
int *  event_num 
) [inherited]

This procedure creates the array of events reading configuration from the section [OSMIUS_INSTANCES]->[IDN]->[EVENTS] of the ConfigFile. Also register the different events with the Reactor (timers)

Parameters:
config_file Input - Configuration file.
idn_instance Input - Instance ID. Also is the section in the cfg file.
typ_instance Input - Instance Type.
con_info Input - Connection Info.
InsManager Input - Instance Manager pointer
event_num Output - Return the number of associated events.
Return values:
-1 in case of error. n > 1 for success n=number of events.

Definition at line 696 of file osm_ag_insmanager.cpp.

References OSM_Message::CODLEN, and OSM_Message::TYPLEN.

int OSM_Instance_Base::close (  )  [virtual, inherited]

Frees the memory allocated by the local array of events. Previously performs the deregistration of timers within the reactor.

Return values:
-1 in case of error. n > 1 for success n=number of events deregistered.

Definition at line 964 of file osm_ag_insmanager.cpp.

References OSM_Instance_Base::disconnect().

Here is the call graph for this function:

ACE_TCHAR* OSM_Instance_Base::idn_instance ( void   )  [inline, inherited]

Returns the instance Id or code.

Definition at line 380 of file osm_ag_insmanager.h.

Referenced by OSM_Event::open().

ACE_TCHAR* OSM_Instance_Base::typ_instance ( void   )  [inline, inherited]

Returns the instance type.

Definition at line 388 of file osm_ag_insmanager.h.


The documentation for this class was generated from the following files:
Generated on Thu Feb 21 18:39:36 2008 for Osmius by  doxygen 1.5.1