Keepalive functions


Functions

VOID CuCmd_EnableKeepAlive (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Enables the keep-alive mechanism.
VOID CuCmd_DisableKeepAlive (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Disables the keep-alive mechanism.
VOID CuCmd_AddKeepAliveMessage (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Adds a keep-alive message.
VOID CuCmd_RemoveKeepAliveMessage (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Removes a keep-alive message.
VOID CuCmd_ShowKeepAlive (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the keep-alive configuration.
VOID Cucmd_ShowPowerConsumptionStats (THandle hCuCmd, ConParm_t parm[], U16 nParms)
 Shows the power consumption statistics.

Detailed Description


Function Documentation

VOID CuCmd_AddKeepAliveMessage ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Adds a keep-alive message.

This function adds a keep-alive message template.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] Keep-alive template index (0 - 1)
parm[1] Keep-alive interval, in msecs (1,000-3,600,000)
parm[2] Keep-alive trigger type, which can be one of the following:
0 - Transmits keep-alive signal only if there is no Tx transmission
1 – Always transmits keep-alive signal
The default is 1.
parm[3] Keep-alive pattern (0 - 128 character string; default = empty).
[in] nParms Always 4
Returns:
None
See also:
CuCmd_DisableKeepAlive(), CuCmd_RemoveKeepAliveMessage()
Note:
A new keep-alive template is added to the firmware. This template is set as enabled. The pattern is converted to hex format. Upon initialization, the keep-alive templates are disabled by default.
Warning:

VOID CuCmd_DisableKeepAlive ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Disables the keep-alive mechanism.

This function disables the keep-alive mechanism. The keep-alive mechanism periodically sends a NULL frame to the AP, in order to notify it that the station is still connected.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
CuCmd_EnableKeepAlive()
Note:
By default, the keep- alive mechanism is enabled.
Warning:

VOID CuCmd_EnableKeepAlive ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Enables the keep-alive mechanism.

This function enables the keep-alive mechanism.
The keep-alive mechanism periodically sends a NULL frame to the AP, in order to notify it that the station is still connected.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not use;, should be 0
Returns:
None
See also:
CuCmd_DisableKeepAlive(), CuCmd_AddKeepAliveMessage()
Note:
By default, the keep-alive mechanism is enabled.
Warning:

VOID CuCmd_RemoveKeepAliveMessage ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Removes a keep-alive message.

This function removes an existing keep-alive message template.

Parameters:
[in] hCuCmd Handle for the command module
[in] parm parm[0] Keep-alive template index (0 - 1;, default = 0).
[in] nParms Always 1
Returns:
None
See also:
CuCmd_AddKeepAliveMessage()
Note:
An existing keep-alive message template is removed from the firmware.
Warning:

VOID CuCmd_ShowKeepAlive ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the keep-alive configuration.

This function gets the keep-alive configuration from the driver and prints it. The following are printed:

  • Whether the global keep- alive flag is enabled or disabled
  • For each of the enabled templates, the following are printed:
    • Template index
    • Trigger type
    • The keep-alive interval, in msecs
    • The pattern

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
CuCmd_AddKeepAliveMessage(), CuCmd_EnableKeepAlive()
Note:
Warning:

VOID Cucmd_ShowPowerConsumptionStats ( THandle  hCuCmd,
ConParm_t  parm[],
U16  nParms 
)

Shows the power consumption statistics.

This function gets the power consumption statistics from the driver and prints themn The following are printed:

  • activeTimeCnt: The total time the chip spent in active state
  • elpTimeCnt: The total time the chip spent in ELP mode
  • powerDownTimeCnt: The total time the chip spent in Power Down mode
  • ListenMode11BTimeCnt: The total time the chip spent in 11b listen mode
  • ListenModeOFDMTimeCnt: The total time the chip spent in OFDM listen mode

Parameters:
[in] hCuCmd Handle for the command module
[in] parm Not used; should be 0
[in] nParms Not used; should be 0
Returns:
None
See also:
Note:
Warning:


Generated on Sun Dec 6 12:34:03 2009 for WLAN DRIVER API REFERENCE MANUAL by  doxygen 1.5.9