OSM_ACT_IMAPGetOK Class Reference

Retrieves pop server connection and authentication codes. value = 1-Ok 0-Not_Ok. More...

#include <osm_ag_ip.h>

Inheritance diagram for OSM_ACT_IMAPGetOK:

[legend]Collaboration diagram for OSM_ACT_IMAPGetOK:

[legend]List of all members.

Public Types
enum	{ OSM_MAX_ACTION_NAME_LEN = 8 }
Public Member Functions
	OSM_ACT_IMAPGetOK ()
	Constructor.
int	execute (const ACE_TCHAR *cmd_line, const int cmd_len, const int timeout, ACE_TCHAR *val_text, int &val_len, int &value)
int	check_cmd_line (const ACE_TCHAR *cmd_line, const int cmd_len)
int	is_name (const ACE_TCHAR *nm)
	Returns 1 if the name of the action is equal to the name in the parameter.
void	set_name (const ACE_TCHAR *nm)
void	instance (OSM_Instance_Base *ins)
const OSM_Instance_Base *	instance (void) const
void	ev_parameters (const ACE_TCHAR *param)
const ACE_TCHAR *	ev_parameters (void) const
const ACE_TCHAR *	name (void) const

---

Detailed Description

Retrieves pop server connection and authentication codes. value = 1-Ok 0-Not_Ok.

Definition at line 402 of file osm_ag_ip.h.

---

Member Function Documentation

int OSM_ACT_IMAPGetOK::execute	(	const ACE_TCHAR *	cmd_line,
		const int	cmd_len,
		const int	timeout,
		ACE_TCHAR *	val_text,
		int &	val_len,
		int &	value
	)			[virtual]

Executes the action using the command line and returns the associated text and value.

Parameters:

	cmd_line	Input - Command line used to execute this action.
	cmd_len	Input - Command line length.
	timeout	Input - Wait timeout seconds before aborting execution.
	val_text	Output - Text of the resulting action.
	val_len	Output - Text length.
	value	Output - 0 fail, 1 OK.

Return values:

-1

in case of error. 0 for success.

Implements OSM_Action_Base.

Definition at line 1853 of file osm_ag_ip.cpp.

References OSM_Instance_IP::ip().

Here is the call graph for this function:

int OSM_ACT_IMAPGetOK::check_cmd_line	(	const ACE_TCHAR *	cmd_line,
		const int	cmd_len
	)			[virtual]

Checks the command line.

Parameters:

	cmd_line	Input - Command line used to execute this action.
	cmd_len	Input - Command line length.

Return values:

-1

in case of error. 0 for success.

Reimplemented from OSM_Action_Base.

Definition at line 2092 of file osm_ag_ip.cpp.

void OSM_Action_Base::set_name

(

const ACE_TCHAR *

nm

)

[inline, inherited]

Sets the name of the action.

Parameters:

nm

Input - Name.

Definition at line 116 of file osm_ag_insmanager.h.

Referenced by OSM_Event::open().

void OSM_Action_Base::instance

(

OSM_Instance_Base *

ins

)

[inline, inherited]

Sets the instance.

Parameters:

ins

Input - Instance pointer.

Definition at line 126 of file osm_ag_insmanager.h.

const OSM_Instance_Base* OSM_Action_Base::instance

(

void

)

const [inline, inherited]

Return a pointer to the instance.

Definition at line 134 of file osm_ag_insmanager.h.

void OSM_Action_Base::ev_parameters

(

const ACE_TCHAR *

param

)

[inline, inherited]

Sets the parameters used in our Event config file.

Parameters:

param

Input - Parameters (command line like).

Definition at line 143 of file osm_ag_insmanager.h.

Referenced by OSM_Event::open().

const ACE_TCHAR* OSM_Action_Base::ev_parameters

(

void

)

const [inline, inherited]

Return pointer to parameters.

Definition at line 152 of file osm_ag_insmanager.h.

const ACE_TCHAR* OSM_Action_Base::name

(

void

)

const [inline, inherited]

Return pointer to my name.

Definition at line 160 of file osm_ag_insmanager.h.

---

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

• agents/ag_ip/osm_ag_ip.h
• agents/ag_ip/osm_ag_ip.cpp

---