metaonly module ti.ndk.config.Telnet
index URL

NDK module used for creating and configuring a telnet server

The Telnet module can be used to configure and create a telnet server in an NDK program. [ more ... ]
Configuration settings sourced in ti/ndk/config/Telnet.xdc
var Telnet = xdc.useModule('ti.ndk.config.Telnet');
module-wide constants & types
    const Telnet.CIS_FLG_CALLBYIP// Specifies that the service should be invoked by IP address = 0x0004;
    const Telnet.CIS_FLG_IFIDXVALID// Specifies if the IfIdx field is valid = 0x0001;
    const Telnet.CIS_FLG_RESOLVEIP// Requests that IfIdx be resolved to an IP address before service execution is initiated = 0x0002;
    const Telnet.CIS_FLG_RESTARTIPTERM// A service that is dependent on a valid IP address (as determined by the RESOLVEIP flag) is shut down if the IP address becomes invalid = 0x0008;
per-instance config parameters
    var params = new Telnet.Params// Instance config-params object;
        params.callBackFxn// Telnet callback function. This is a handle to the function which contains the telnet server code = Int(*)(Void*) null;
        params.ifIdx// The physical device index on which the telnet server shall be executed. Must be greater than zero = Int 1;
        params.ipAddr// The IP address on which to initiate this service = String "INADDR_ANY";
        params.maxCon// The maximum number of connections for the telnet server (1 - 24) = Int 8;
        params.mode// Set of flags which represent the desired behavior of the telnet Server = Int 0;
        params.pCbSrv// Telnet service reporting function = Void(*)(Int,Int,Int,Void*) '&ti_ndk_config_Global_serviceReport';
        params.port// The port number which this telnet server will accept connections = Int 23;
per-instance creation
    var inst = Telnet.create// Create an instance-object(params);
 
DETAILS
The Telnet module can be used to configure and create a telnet server in an NDK program.
In order to configure a telnet server, users must create a Telnet module parameters structure, which contains all of the instance properties of a Telnet instance. Once the parameter structure is created, it may be used to change the properties of the telnet server that's being created.
Users are able to create multiple telnet servers by creating multiple Telnet instances, and configuring each one. However, if multiple Telnet instances are created, one must be careful to ensure that they all have been configured to have unique and free port numbers.
 
const Telnet.CIS_FLG_CALLBYIP
index URL

Specifies that the service should be invoked by IP address

Configuration settings
const Telnet.CIS_FLG_CALLBYIP = 0x0004;
 
 
const Telnet.CIS_FLG_IFIDXVALID
index URL

Specifies if the IfIdx field is valid

Configuration settings
const Telnet.CIS_FLG_IFIDXVALID = 0x0001;
 
 
const Telnet.CIS_FLG_RESOLVEIP
index URL

Requests that IfIdx be resolved to an IP address before service execution is initiated

Configuration settings
const Telnet.CIS_FLG_RESOLVEIP = 0x0002;
 
 
const Telnet.CIS_FLG_RESTARTIPTERM
index URL

A service that is dependent on a valid IP address (as determined by the RESOLVEIP flag) is shut down if the IP address becomes invalid

Configuration settings
const Telnet.CIS_FLG_RESTARTIPTERM = 0x0008;
 
DETAILS
When this flag is set, the service will be restarted when a new address becomes available. Otherwise; the service will not be restarted.
Instance Config Parameters
index URL

Configuration settings
var params = new Telnet.Params;
// Instance config-params object
    params.callBackFxn = Int(*)(Void*) null;
    // Telnet callback function. This is a handle to the function which contains the telnet server code
    params.ifIdx = Int 1;
    // The physical device index on which the telnet server shall be executed. Must be greater than zero
    params.ipAddr = String "INADDR_ANY";
    // The IP address on which to initiate this service
    params.maxCon = Int 8;
    // The maximum number of connections for the telnet server (1 - 24)
    params.mode = Int 0;
    // Set of flags which represent the desired behavior of the telnet Server
    params.pCbSrv = Void(*)(Int,Int,Int,Void*) '&ti_ndk_config_Global_serviceReport';
    // Telnet service reporting function
    params.port = Int 23;
    // The port number which this telnet server will accept connections
 
config Telnet.Params.callBackFxn  // instance
index URL

Telnet callback function. This is a handle to the function which contains the telnet server code

Configuration settings
var params = new Telnet.Params;
  ...
params.callBackFxn = Int(*)(Void*) null;
 
 
config Telnet.Params.ifIdx  // instance
index URL

The physical device index on which the telnet server shall be executed. Must be greater than zero

Configuration settings
var params = new Telnet.Params;
  ...
params.ifIdx = Int 1;
 
 
config Telnet.Params.ipAddr  // instance
index URL

The IP address on which to initiate this service

Configuration settings
var params = new Telnet.Params;
  ...
params.ipAddr = String "INADDR_ANY";
 
DETAILS
To accept a connection from any IP, specify INADDR_ANY.
 
config Telnet.Params.maxCon  // instance
index URL

The maximum number of connections for the telnet server (1 - 24)

Configuration settings
var params = new Telnet.Params;
  ...
params.maxCon = Int 8;
 
 
config Telnet.Params.mode  // instance
index URL

Set of flags which represent the desired behavior of the telnet Server

Configuration settings
var params = new Telnet.Params;
  ...
params.mode = Int 0;
 
DETAILS
The following flag values may be set either individually, or by or-ing flags together:
  • CIS_FLG_IFIDXVALID - specifies if the IfIdx field is valid.
  • CIS_FLG_RESOLVEIP - Requests that IfIdx be resolved to an IP addressbefore service execution is initiated.
  • CIS_FLG_CALLBYIP - Specifies that the service should be invoked by IP address
  • CIS_FLG_RESTARTIPTERM - A service that is dependent on a valid IP address.
 
config Telnet.Params.pCbSrv  // instance
index URL

Telnet service reporting function

Configuration settings
var params = new Telnet.Params;
  ...
params.pCbSrv = Void(*)(Int,Int,Int,Void*) '&ti_ndk_config_Global_serviceReport';
 
 
config Telnet.Params.port  // instance
index URL

The port number which this telnet server will accept connections

Configuration settings
var params = new Telnet.Params;
  ...
params.port = Int 23;
 
Static Instance Creation
index URL

Configuration settings
var params = new Telnet.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = Telnet.create(params);
// Create an instance-object
generated on Fri, 05 Feb 2016 20:07:57 GMT