yumapro  20.10-14
YumaPro SDK

YControl session handler will create and manage session control blocks for the subsystem. More...

Collaboration diagram for Sessions:

Functions

status_t ycontrol_ses_init (ycontrol_profile_t *profile)
 Setup the YControl session handler. More...
 
void ycontrol_ses_cleanup (ycontrol_profile_t *profile)
 Cleanup ycontrol session handler. More...
 
status_t ycontrol_ses_attempt_connect (ycontrol_profile_t *profile)
 Attempt to connect to the server. More...
 
void ycontrol_ses_free_session (ycontrol_profile_t *profile, ses_id_t sid)
 Free a real session control block. More...
 
boolean ycontrol_ses_process_first_ready (ycontrol_profile_t *profile)
 Check the readyQ and process the first message, if any. More...
 
ses_cb_tycontrol_ses_get_first_outready (ycontrol_profile_t *profile)
 Get the first ses_msg outreadyQ entry. More...
 

Detailed Description

YControl session handler will create and manage session control blocks for the subsystem.

The same ses_cb_t is used on the main server and the subsystems.

All functions in this module are internal system APIs for subsystem use only!

Function Documentation

◆ ycontrol_ses_attempt_connect()

status_t ycontrol_ses_attempt_connect ( ycontrol_profile_t profile)

Attempt to connect to the server.

Parameters
profileservice profile to use
Returns
status
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ycontrol_ses_cleanup()

void ycontrol_ses_cleanup ( ycontrol_profile_t profile)

Cleanup ycontrol session handler.

Parameters
profileycontrol profile to use
Here is the caller graph for this function:

◆ ycontrol_ses_free_session()

void ycontrol_ses_free_session ( ycontrol_profile_t profile,
ses_id_t  sid 
)

Free a real session control block.

Parameters
profileservice profile to use
sidsession ID of session to free
Here is the call graph for this function:

◆ ycontrol_ses_get_first_outready()

ses_cb_t* ycontrol_ses_get_first_outready ( ycontrol_profile_t profile)

Get the first ses_msg outreadyQ entry.

Will remove the entry from the Q

Parameters
profileycontrol message handler control block
Returns
pointer to the session control block of the first session ready to write output to a socket or the screen or a file
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ycontrol_ses_init()

status_t ycontrol_ses_init ( ycontrol_profile_t profile)

Setup the YControl session handler.

Parameters
profileycontrol profile to use
Returns
status
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ycontrol_ses_process_first_ready()

boolean ycontrol_ses_process_first_ready ( ycontrol_profile_t profile)

Check the readyQ and process the first message, if any.

Parameters
profileycontrol message handler control block
Returns
TRUE if a message was processed
FALSE if the readyQ was empty
Here is the call graph for this function:
Here is the caller graph for this function: