LTKCPP-- LLRP Toolkit C Plus Plus Library
Public Member Functions | Protected Attributes
CERROR_MESSAGE Class Reference

Class Definition CERROR_MESSAGE for LLRP message ERROR_MESSAGE. More...

#include <out_ltkcpp.h>

List of all members.

Public Member Functions

CLLRPStatusgetLLRPStatus (void)
 Get accessor functions for the LLRP LLRPStatus sub-parameter.
EResultCode setLLRPStatus (CLLRPStatus *pValue)
 Set accessor functions for the LLRP LLRPStatus sub-parameter.
CLLRPStatusgetLLRPStatus (void)
 Get accessor functions for the LLRP LLRPStatus sub-parameter.
EResultCode setLLRPStatus (CLLRPStatus *pValue)
 Set accessor functions for the LLRP LLRPStatus sub-parameter.

Protected Attributes

CLLRPStatusm_pLLRPStatus

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
static const CTypeDescriptor s_typeDescriptor
void decodeFields (CDecoderStream *pDecoderStream)
void assimilateSubParameters (CErrorDetails *pError)
void encode (CEncoderStream *pEncoderStream) const
void decodeFields (CDecoderStream *pDecoderStream)
void assimilateSubParameters (CErrorDetails *pError)
void encode (CEncoderStream *pEncoderStream) const
static CElement * s_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
static CElement * s_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)

Detailed Description

Class Definition CERROR_MESSAGE for LLRP message ERROR_MESSAGE.

The Reader SHALL discard the message if there is at least one error in the message, or cannot be fully processed. In addition, no portion of the message containing an error SHALL be executed by the Reader. In case the message has one or more errors, the Reader SHALL return at least one error parameter for one of the errors. The Reader MAY return more than one error parameter, one for each error. The errors are conveyed using a combination of "generic error codes", a pointer to the culprit parameter/field, and a description of the error encoded as a string of UTF-8 characters.

Typically the errors in the LLRP defined messages are conveyed inside of the responses from the Reader. However, in cases where the message received by the Reader contains an unsupported message type, or a CUSTOM_MESSAGE with unsupported parameters or fields, the Reader SHALL respond with the ERROR_MESSAGE.

When a Reader or Client receives a command or notification with a version that is not supported, the receiver SHALL send an ERROR_MESSAGE in reply consisting of: A version that is the same as the received message, the message ID that matches the received message, and an LLRPStatusParameter with the ErrorCode set to M_UnsupportedVersion. This message SHALL contain no sub-parameters (such as Field Error, Parameter Error).

Readers and Clients SHALL not respond to an ERROR_MESSAGE.

This message is issued by the Reader to the Client, and it contains the LLRPStatus parameter that describes the error in the message.

Copyright 2006, 2007, EPCglobal Inc. The proprietary text of EPCglobal Inc. included here is in not a Contribution to the LLRP toolkit, under Apache License, Version 2.0. The right to use the proprietary text is limited to reproduction and display thereof within the work.


Definition at line 6897 of file Library/out_ltkcpp.h.


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