yumapro  20.10-10
YumaPro SDK
Utility Functions

Subsystem utility functions are used to provide support functions to implement the subsystem. More...

Collaboration diagram for Utility Functions:

Data Structures

struct  subsys_cb_t
 one subsystem control block for session More...
 

Functions

status_t get_ssh_parms (subsys_cb_t *cb)
 Get the SSH environment parameters. More...
 
status_t start_connection (subsys_cb_t *cb)
 Start the connection to the server. More...
 
status_t send_cli_ncxconnect (subsys_cb_t *cb)
 Send the <ncx-connect> message to the ncxserver for CLI protocol. More...
 
void init_subsys_cb (subsys_cb_t *cb)
 Initialize the fields of a subsystem control block. More...
 
void clean_subsys_cb (subsys_cb_t *cb)
 Clean the fields of a subsystem control block. More...
 
void configure_cli_parms (subsys_cb_t *cb, int argc, char **argv)
 Configure CLI parameters. More...
 
status_t start_subsys_ypshell (int *retfd)
 Start the subsystem for yp-shell. More...
 
status_t start_subsys_tcp_ncx (int *retfd, const char *user)
 Start the subsystem for a tcp-ncx transport connection. More...
 
status_t start_subsys_extern_tcp_ncx (int *retfd, const char *user, const char *addr, unsigned int portnum)
 Start the subsystem to connect to an external tcp-ncx socket. More...
 

Detailed Description

Subsystem utility functions are used to provide support functions to implement the subsystem.

CLI parameters and RESTCONF request parameters are supported.

Function Documentation

void clean_subsys_cb ( subsys_cb_t cb)

Clean the fields of a subsystem control block.

Parameters
cbcontrol block to clean

Here is the caller graph for this function:

void configure_cli_parms ( subsys_cb_t cb,
int  argc,
char **  argv 
)

Configure CLI parameters.

Configure debug logging. This function evaluates command line arguments to configure debug logging.

Also configure the protocol in use

Parameters
cbcontrol block to use to store parameter values
argccommand line parameter count
argvarray of command line parameter strings

Here is the caller graph for this function:

status_t get_ssh_parms ( subsys_cb_t cb)

Get the SSH environment parameters.

Parameters
cbcontrol vlock to use
Returns
status

Here is the caller graph for this function:

void init_subsys_cb ( subsys_cb_t cb)

Initialize the fields of a subsystem control block.

Parameters
cbcontrol block to initialize

Here is the caller graph for this function:

status_t send_cli_ncxconnect ( subsys_cb_t cb)

Send the <ncx-connect> message to the ncxserver for CLI protocol.

Parameters
cbcontrol vlock to use
Returns
status

Here is the call graph for this function:

Here is the caller graph for this function:

status_t start_connection ( subsys_cb_t cb)

Start the connection to the server.

Parameters
cbcontrol vlock to use
Returns
status

Here is the caller graph for this function:

status_t start_subsys_extern_tcp_ncx ( int *  retfd,
const char *  user,
const char *  addr,
unsigned int  portnum 
)

Start the subsystem to connect to an external tcp-ncx socket.

Initialize the subsystem, and get it ready to send and receive the first message of any kind; special version for tcp-ncx transport

Parameters
retfdaddress of return file desciptor number assigned to the socket that was created
userdummy user name
addrexternal server address
portnumexternal server port number
Return values
*retfdthe file descriptor number used for the socket
Returns
status

Here is the call graph for this function:

status_t start_subsys_tcp_ncx ( int *  retfd,
const char *  user 
)

Start the subsystem for a tcp-ncx transport connection.

Initialize the subsystem, and get it ready to send and receive the first message of any kind; special version for tcp-ncx transport

Parameters
retfdaddress of return file desciptor number assigned to the socket that was created
useruser ID to login to server
Return values
*retfdthe file descriptor number used for the socket
Returns
status

Here is the call graph for this function:

status_t start_subsys_ypshell ( int *  retfd)

Start the subsystem for yp-shell.

Initialize the subsystem, and get it ready to send and receive the first message of any kind; special version for yp-shell

Parameters
retfdaddress of return file desciptor number assigned to the socket that was created
Return values
*retfdthe file descriptor number used for the socket
Returns
status

Here is the call graph for this function: