OverView Index Help WebNMS Agent Toolkit C Edition 6

sshtp.c

File contains methods for SSH socket operation like read write etc.

Return Type	Method Summary
void*	`AcceptSSHClientConnection(void *serverSock)` Accepts a client request.
U_CHAR	`CloseSshConnection(void * clientSock, INT32 sockType, INT32 sessionID)` Closes a Ssh connection.
void*	`ConnectWithSSHServer(void *ptr)` It will make the ssh connection with another application.
TransportProvider*	`CreateSSHTransportProvider(SSHProperties *sshPropPtr)` Creates a TransportProvider reference for SSH.
INT32	`ReadSSHMessage(U_CHAR * mesgBuf, INT32 length, void *clientSock)` Reveives input message from client.
U_CHAR	`SshSelect(void * clientSessionVect, void * fdSetData, U_CHAR opern)` Check if any message is waiting to be read.
void*	`StartSSHServer(void *serverParam)` It will do all necessary initialization required for the SSH socket communication.
INT32	`WriteSSHMessage(U_CHAR * mesgBuf, INT32 mesgLen, void *clientSock)` Sends response message to client.

Method Details

AcceptSSHClientConnection()

void* AcceptSSHClientConnection(void *serverSock)

Accepts a client request.

Arguments:

1. Server Socket details.

Return type:

Client session details or NULL .

Bugs:

null

CloseSshConnection()

U_CHAR CloseSshConnection(void * clientSock,INT32 sockType,INT32 sessionID)

Closes a Ssh connection.

Arguments:

1. Socket to be closed.

Return type:

SUCCESS on successful initializatio of socket.

Bugs:

null

ConnectWithSSHServer()

void* ConnectWithSSHServer(void *ptr)

It will make the ssh connection with another application.

Arguments:

1. server details.

Return type:

ClientSocket.

Bugs:

null

CreateSSHTransportProvider()

TransportProvider* CreateSSHTransportProvider(SSHProperties *sshPropPtr)

Creates a TransportProvider reference for SSH.

Arguments:

1. Reference to SSHProperties.

Return type:

SUCCESS/FAILURE.

Bugs:

null

See Also:

ReadSSHMessage()

INT32 ReadSSHMessage(U_CHAR * mesgBuf,INT32 length,void *clientSock)

Reveives input message from client.

Arguments:

1. buffer to store message read.

2. Message length

3. Client Socket details

Return type:

Length of Message read

Bugs:

null

SshSelect()

U_CHAR SshSelect(void * clientSessionVect,void * fdSetData,U_CHAR opern)

Check if any message is waiting to be read.

Arguments:

1. Reference to all the connected clients.

2. Fd_Set

Return type:

SUCCESS otherwise FAILURE.

Bugs:

null

StartSSHServer()

void* StartSSHServer(void *serverParam)

It will do all necessary initialization required for the SSH socket communication.

Arguments:

1. Server details.

Return type:

server Socket details or NULL.

Bugs:

null

WriteSSHMessage()

INT32 WriteSSHMessage(U_CHAR * mesgBuf,INT32 mesgLen,void *clientSock)

Sends response message to client.

Arguments:

1. Message to be sent.

2. Length of message.

3. Reference to client details.

Return type:

Length of message sent.

Bugs:

null

OverView Index Help WebNMS Agent Toolkit C Edition 6