ZPS_tsAfErrorEvent

This structure is used in the ZPS_EVENT_ERROR event, which reports error situations concerning the storage of received messages in APDU instances.

The ZPS_tsAfErrorEventstructure is detailed below.

typedef struct {
    enum {
        ZPS_ERROR_APDU_TOO_SMALL,
        ZPS_ERROR_APDU_INSTANCES_EXHAUSTED,
        ZPS_ERROR_NO_APDU_CONFIGURED,
        ZPS_ERROR_OS_MESSAGE_QUEUE_OVERRUN
    } eError;
   union {
         struct {
            uint16 u16ProfileId;
            uint16 u16ClusterId;
            uint16 u16SrcAddr;
            uint16 u16DataSize;
            PDUM_thAPdu hAPdu;
            uint8 u8SrcEndpoint;
            uint8 u8DstEndpoint;
        }sAfErrorApdu;
        struct {
            OS_thMessage hMessage;
        } sAfErrorOsMessageOverrun;
    } uErrorData;
} ZPS_tsAfErrorEvent;

The member enumerations and structures of the above structure are detailed below.

eError enumerations

The error enumerations which are part of the ZPS_tsAfErrorEventstructure are listed and described below.

eError Enumerations

eError Enumeration

Description

ZPS_ERROR_APDU_TOO_SMALL

Allocated APDU instance is too small to accommodate received message. This error is detailed in the structure sAfErrorApdu, which is described below.

ZPS_ERROR_APDU_INSTANCES_EXHAUSTED

The are no APDU instances available to accommodate the received message. This error is detailed in the structure sAfErrorApdu, which is described below.

ZPS_ERROR_NO_APDU_CONFIGURED

No APDU has been configured to accommodate the received message. This error is detailed in the structure sAfErrorApdu, which is described below.

ZPS_ERROR_OS_MESSAGE_QUEUE_OVERRUN

A message queue is full and can accept no more messages. This error is detailed in the structure sAfErrorOsMessageOverrun, which is described below.

sAfErrorApdu

This structure is used in the following errors:

  • ZPS_ERROR_APDU_TOO_SMALL, which reports that the allocated APDU instance is too small to store a received message.

  • ZPS_ERROR_APDU_INSTANCES_EXHAUSTED, which reports that there are no allocated APDU instances left to store a received message.

  • ZPS_ERROR_NO_APDU_CONFIGURED, which reports that no APDU has been configured to store the received message.

The sAfErrorApdustructure is detailed below.

struct {
    uint16 u16ProfileId;
    uint16 u16ClusterId;
    uint16 u16SrcAddr;
    uint16 u16DataSize;
    PDUM_thAPdu hAPdu;
    uint8 u8SrcEndpoint;
    uint8 u8DstEndpoint;
}sAfErrorApdu;

where:

  • u16ProfileIdis the identifier of the ZigBee application profile associated with the source and destination endpoints for the message.

  • u16ClusterIdis the identifier of the cluster associated with the source and destination endpoints for the message.

  • u16SrcAddris the 16-bit network address of the source node of the message.

  • u16DataSizeis the size of the received message, in bytes.

  • hAPduis the handle of the local APDU pool from which the APDU instance comes.

  • u8SrcEndpointis the number of the source endpoint of the message.

  • u8DstEndpointis the number of the destination endpoint of the message.

Parent topic:ZPS_tsAfErrorEvent

sAfErrorOsMessageOverrun

This structure is used in the ZPS_ERROR_OS_MESSAGE_QUEUE_OVERRUN error, which indicates that a message queue is full and can accept no more messages.

The sAfErrorOsMessageOverrunstructure is detailed below.

struct {
    OS_thMessage hMessage;
} sAfErrorOsMessageOverrun;

where hMessageis the handle of the message type for the queue which is full.

Parent topic:ZPS_tsAfErrorEvent

Parent topic:Event structures