Telnet Server API#
TELNETs_ConfigureMemSeg()#
Description#
Configure the memory segment that will be used to allocate internal data needed by the TELNET server module instead of the default memory segment.
Files#
telnet_server.h/telnet_server.c
Prototype#
void TELNETs_ConfigureMemSeg (MEM_SEG *p_mem_seg)
Arguments#
p_mem_seg
Pointer to the memory segment from which the internal data will be allocated. If DEF_NULL
, the internal data will be allocated from the global Heap.
Returned Value#
None.
Notes / Warnings#
This function is optional. If it is called, it must be called before
TELNETs_Init()
. If it is not called, default values will be used to initialize the module.
TELNETs_Init()#
Description#
Initializes the TELNET server module.
Files#
telnet_server.h/telnet_server.c
Prototype#
void TELNETs_Init (RTOS_ERR *p_err)
Arguments#
p_err
Pointer to the variable that will receive one of the following error code(s) from this function:
RTOS_ERR_NONE
RTOS_ERR_SEG_OVF
Returned Value#
None.
Notes / Warnings#
TELNETs_Init()
MUST be called only AFTER the product's OS and network have been initialized.TELNETs_Init()
MUST ONLY be called ONCE from the product's application.
TELNETs_InstanceInit()#
Description#
Initializes a TELNET server instance.
Files#
telnet_server.h/telnet_server.c
Prototype#
TELNETs_INSTANCE *TELNETs_InstanceInit (const TELNETs_CFG *p_cfg,
const RTOS_TASK_CFG *p_task_srv_cfg,
const RTOS_TASK_CFG *p_task_session_cfg,
RTOS_ERR *p_err);
Arguments#
p_cfg
Pointer to the instance configuration object.
p_task_srv_cfg
Pointer to the instance task server configuration object.
p_task_session_cfg
Pointer to the instance task session configuration object.
p_err
Pointer to the variable that will receive one of the following error code(s) from this function:
RTOS_ERR_NONE
RTOS_ERR_POOL_EMPTY
RTOS_ERR_INVALID_HANDLE
RTOS_ERR_INVALID_TYPE
RTOS_ERR_NOT_FOUND
RTOS_ERR_ALREADY_EXISTS
RTOS_ERR_NET_INVALID_CONN
RTOS_ERR_INVALID_STATE
RTOS_ERR_NET_CONN_CLOSED_FAULT
RTOS_ERR_OS_ILLEGAL_RUN_TIME
Returned Value#
None.
Notes / Warnings#
None.
TELNETs_InstanceStart()#
Description#
Starts a specific TELNET server instance which had been previously initialized.
Files#
telnet_server.h/telnet_server.c
Prototype#
void TELNETs_InstanceStart(TELNETs_INSTANCE *p_instance,
RTOS_ERR *p_err)
Arguments#
p_instance
Pointer to specific TELNET server instance handler.
p_err
Pointer to the variable that will receive one of the following error code(s) from this function :
RTOS_ERR_NONE
RTOS_ERR_OS_ILLEGAL_RUN_TIME
RTOS_ERR_INVALID_TYPE
RTOS_ERR_POOL_EMPTY
RTOS_ERR_NOT_FOUND
RTOS_ERR_ALREADY_EXISTS
RTOS_ERR_INVALID_HANDLE
RTOS_ERR_NET_INVALID_CONN
RTOS_ERR_INVALID_STATE
RTOS_ERR_NET_CONN_CLOSED_FAULT
Returned Value#
None.
Notes / Warnings#
None.