LLRP::CImpinjLinkMonitorConfiguration Class Reference
[Impinj Parameter Classes]

Class Definition CImpinjLinkMonitorConfiguration for LLRP parameter ImpinjLinkMonitorConfiguration. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjLinkMonitorConfiguration:

LLRP::CParameter LLRP::CElement

List of all members.

Public Member Functions

EImpinjLinkMonitorMode getLinkMonitorMode (void)
 Get accessor functions for the LLRP LinkMonitorMode field.
void setLinkMonitorMode (EImpinjLinkMonitorMode value)
 Set accessor functions for the LLRP LinkMonitorMode field.
llrp_u16_t getLinkDownThreshold (void)
 Get accessor functions for the LLRP LinkDownThreshold field.
void setLinkDownThreshold (llrp_u16_t value)
 Set accessor functions for the LLRP LinkDownThreshold field.
std::list< CParameter * >::iterator beginCustom (void)
 Returns the first element of the Custom sub-parameter list.
std::list< CParameter * >::iterator endCustom (void)
 Returns the last element of the Custom sub-parameter list.
void clearCustom (void)
 Clears the LLRP Custom sub-parameter list.
int countCustom (void)
 Count of the LLRP Custom sub-parameter list.
EResultCode addCustom (CParameter *pValue)
 Add a Custom to the LLRP sub-parameter list.

Static Public Attributes

Internal Framework Functions


static const CFieldDescriptor s_fdLinkMonitorMode
Internal Framework Functions


static const CFieldDescriptor s_fdLinkDownThreshold

Protected Attributes

EImpinjLinkMonitorMode m_eLinkMonitorMode
llrp_u16_t m_LinkDownThreshold
std::list< CParameter * > m_listCustom

Internal Framework Functions



static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
static const CTypeDescriptor s_typeDescriptor
void decodeFields (CDecoderStream *pDecoderStream)
 Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.
void assimilateSubParameters (CErrorDetails *pError)
 Assimilates the decoded sub-parameters into m_listAllSubParameters.
void encode (CEncoderStream *pEncoderStream) const
 Encode fields and subparameters.
llrp_bool_t isAllowedIn (const CTypeDescriptor *pEnclosingElementType) const
 Validate whether the element is allowed as a base type in the enclosing element.
static CElements_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)


Detailed Description

Class Definition CImpinjLinkMonitorConfiguration for LLRP parameter ImpinjLinkMonitorConfiguration.

This custom parameter configures the Reader to monitor LLRP link health using KEEPALIVE and KEEPALIVE_ACK messages. When disabled or unsupported, the Reader ignores KEEPALIVE_ACK messages entirely. When this parameter is enabled, if the Reader fails to receive LinkDownThreshold consecutive KEEPALIVE_ACK messages from the Client, the Reader will close the current connection. Note that this parameter must be configured in conjunction with the KeepaliveSpec LLRP parameter in the standard LLRP configuration. The frequency with which the Reader is configured to send KEEPALIVE messages, along with the threshold set in this parameter determines how long the Reader will tolerate missing KEEPALIVE_ACK messages. The Reader uses the LLRP MessageID field to correlate KEEPALIVE and KEEPALIVE_ACK messages. Clients must send the same MessageID when responding to reader KEEPALIVE requests.

Copyright 2009 Impinj Inc.


Definition at line 5285 of file impinj_ltkcpp.h.


Member Function Documentation

void LLRP::CImpinjLinkMonitorConfiguration::assimilateSubParameters ( CErrorDetails pError  )  [virtual]

Assimilates the decoded sub-parameters into m_listAllSubParameters.

After fields are decoded, the CDecoder itself takes care of gathering the subparameters into m_listAllSubParameters. Once the end of the enclosing TLV (or message) is reached this assimilateSubParameters() function is called to create parameter refrences from the primary member variables.

Parameters:
[out] pError Error details for encoded stream

Implements LLRP::CElement.

void LLRP::CImpinjLinkMonitorConfiguration::decodeFields ( CDecoderStream pDecoderStream  )  [virtual]

Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.

Parameters:
[in] pDecoderStream The stream from which to decode fields
Returns:
void

Implements LLRP::CElement.

void LLRP::CImpinjLinkMonitorConfiguration::encode ( CEncoderStream pEncoderStream  )  const [virtual]

Encode fields and subparameters.

Parameters:
[in] pEncoderStream Stream to encode
Returns:
void

Implements LLRP::CElement.

llrp_bool_t LLRP::CImpinjLinkMonitorConfiguration::isAllowedIn ( const CTypeDescriptor pEnclosingTypeDescriptor  )  const [virtual]

Validate whether the element is allowed as a base type in the enclosing element.

Parameters:
[in] pEnclosingTypeDescriptor A pointer to the enclosing type
Returns:
TRUE if the element is allowed to be encoded within the EnclosingElement

FALSE if the element is not allowed to be encoded within the EnclosingElement

Reimplemented from LLRP::CParameter.


The documentation for this class was generated from the following file:

Generated on Wed Jun 6 11:55:51 2012 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.5.9