OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
clibuiltcmdhdlr.c.
This file contains methods for processing built in command.
Return Type Method Summary
CHAR* ClearUsage(U_CHAR *errStatus)
             This function will be called when clear command is received with invalid options.
U_CHAR* ErrormessAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* ErrormessUsage(U_CHAR *errStatus)
             This function will be called when errormess command is received with invalid options.
void FreeerrorMessCommand()
             Frees resources allocated for the errormess.
void FreeinputMessCommand()
             Frees resources allocated for the inputmess.
void FreekeepliveCommand()
             Frees resources allocated for the keeplive.
void FreeListCommand()
             Frees resources allocated for the list.
void FreepromptnameCommand()
             Frees resources allocated for the promptname.
void FreeresponseMessCommand()
             Frees resources allocated for the responsemess.
void FreesessionNumCommand()
             Frees resources allocated for the sessionnum.
CHAR InitCLIBuiltInCmd()
             The function registers built in commands.
CHAR InitClear()
             This method is called at agent startup.
CHAR InitErrormess()
             This method is called at agent startup.
CHAR InitInputmess()
             This method is called at agent startup.
CHAR InitKeeplive()
             This method is called at agent startup.
CHAR InitKeepliveParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitList()
             This method is called at agent startup.
CHAR InitListParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitPromptname()
             This method is called at agent startup.
CHAR InitPromptnameParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitResponsemess()
             This method is called at agent startup.
CHAR InitSessionnum()
             This method is called at agent startup.
CHAR InitSessionnumParameter(StringCommand *cmdPtr, U_CHAR mode)
             This method will be called by action method.
CHAR InitWho()
             This method is called at agent startup.
U_CHAR* KeepliveAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* KeepliveUsage(U_CHAR *errStatus)
             This function will be called when keeplive command is received with invalid options.
CHAR* ListUsage(U_CHAR *errStatus)
             This function will be called when list command is received with invalid options.
CHAR* PromptnameUsage(U_CHAR *errStatus)
             This function will be called when promptname command is received with invalid options.
CHAR* SessionnumUsage(U_CHAR *errStatus)
             This function will be called when session command is received with invalid options.
U_CHAR* SessionnumAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)
             This method will be called by CLI Engine upon receiving the CLI command.
CHAR* WhoUsage(U_CHAR *errStatus)
             This function will be called when who command is received with invalid options.
   
Method Details

ClearUsage().

CHAR* ClearUsage( U_CHAR *errStatus)

This function will be called when clear command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

ErrormessAction().

U_CHAR* ErrormessAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs :

ErrormessUsage().

CHAR* ErrormessUsage( U_CHAR *errStatus)

This function will be called when errormess command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

FreeErrormessCommand().

void FreeerrorMessCommand()

Frees resources allocated for the errormess.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreeInputmessCommand().

void FreeinputMessCommand()

Frees resources allocated for the inputmess.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreeKeepliveCommand().

void FreekeepliveCommand()

Frees resources allocated for the keeplive.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreeListCommand().

void FreeListCommand()

Frees resources allocated for the list.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreePromptnameCommand().

void FreepromptnameCommand()

Frees resources allocated for the promptname.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreeResponsemessCommand().

void FreeresponseMessCommand()

Frees resources allocated for the responsemess.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

FreesessionnumCommand().

void FreesessionNumCommand()

Frees resources allocated for the sessionnum.

Arguments:
Nothing.
Return type:
Nothing.
Bugs:
Bugs :

InitCLIBuiltInCmd()

CHAR InitCLIBuiltInCmd(void)

The function registers built in commands.

Arguments:
Nothing.
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitClear().

CHAR InitClear(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitErrormess().

CHAR InitErrormess(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitInputmess().

CHAR InitInputmess(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitKeeplive().

CHAR InitKeeplive(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitKeepliveParameter().

CHAR InitKeepliveParameter(StringCommand *cmdPtr, U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitList().

CHAR InitList(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitListParameter().

CHAR InitListParameter(StringCommand *cmdPtr, U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitPromptname().

CHAR InitPromptname(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitPromptnameParameter().

CHAR InitPromptnameParameter(StringCommand *cmdPtr, U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitResponsemess().

CHAR InitResponsemess(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitSessionnum().

CHAR InitSessionnum(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

InitSessionnumParameter().

CHAR InitSessionnumParameter(StringCommand *cmdPtr, U_CHAR mode)

This method will be called by action method. This will initialize ls argument structure.

Arguments:
1.Reference to the received command(IN).
2.Mode(IN).
Return type:
SUCCESS/FAILURE
Bugs:
Bugs :

InitWho().

CHAR InitWho(void)

This method is called at agent startup.It registers its action method with CLI registry.On successful registration it returns SUCCESS else it returns FAILURE.

Arguments:
Nothing
Return type:
SUCCESS/FAILURE.
Bugs:
Bugs :

KeepliveAction().

U_CHAR* KeepliveAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs :

KeepliveUsage().

CHAR* KeepliveUsage( U_CHAR *errStatus)

This function will be called when keeplive command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

ListUsage().

CHAR* ListUsage( U_CHAR *errStatus)

This function will be called when list command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

PromptnameUsage().

CHAR* PromptnameUsage( U_CHAR *errStatus)

This function will be called when promptname command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

SessionUsage().

CHAR* SessionnumUsage( U_CHAR *errStatus)

This function will be called when session command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :

SessionnumAction().

U_CHAR* SessionnumAction(StringCommand * commandPtr, ClientSession *clientSesPtr, void *infoPtr, U_CHAR *errStatus)

This method will be called by CLI Engine upon receiving the CLI command.Here, user can write his code to perform the necessary action upon receiving the CLI command.

Arguments:
1. Reference to the parsed command(IN).
2. Session Information(IN).
3. General Information(IN/OUT).
4. Error Status(OUT).
Return type:
This method returns response message or error message.
Bugs:
Bugs :

WhoUsage().

CHAR* WhoUsage( U_CHAR *errStatus)

This function will be called when who command is received with invalid options.User can cutomize the usage string to his requirements.

Arguments:
1. Error Status(OUT).
Return type:
Usage string.
Bugs:
Bugs :
OverView Index Help                                                                WebNMS Agent Toolkit C Edition 6 
Copyright (c) 2009 ZOHO Corp. All Rights Reserved.