ZPS_eAplZdpStoreBkupBindEntryRequest

ZPS_teStatus ZPS_eAplZdpStoreBkupBindEntryRequest(
            PDUM_thAPdu hAPdu,
            ZPS_tuAddress uDstAddr,
            bool bExtAddr,
            uint8 *pu8SeqNumber,
            uint16 u16ProfileId,
            ZPS_tsAplZdpStoreBkupBindEntryReq
                      *psZdpStoreBkupBindEntryReq);

Description

This function requests that a back-up of an entry in the local primary binding table cache is performed on a remote node. The destination node of the request must hold the corresponding back-up binding table cache. The back-up operation is normally required when a new entry has been added to the primary binding table cache.

Note: This function is provided in the NXP ZDP API for the reason of interoperability with nodes running non-NXP ZigBee PRO stacks that support the generated request. On receiving a request from this function, the NXP ZigBee PRO stack will return the status ZPS_ZDP_NOT_SUPPORTED.

This request must include the binding table entry to be backed up. The request is represented by the structure below (further detailed in Section 9.2.2.27).

typedef struct {
        uint64 u64SrcAddress;
        uint8 u8SrcEndPoint;
        uint16 u16ClusterId;
        uint8 u8DstAddrMode;
        union {
           struct {
                uint16 u16DstAddress;
                  } sShort;
        struct {
        uint64 u64DstAddress;
        uint8 u8DstEndPoint;
        } sExtended;
      };
} ZPS_tsAplZdpStoreBkupBindEntryReq;

On receiving the request, the remote node adds the specified binding table entry to its back-up binding table cache, if possible.

The remote node replies with a Store_Bkup_Bind_Entry_rsp response, which should be collected using the function ZQ_bZQueueReceive() and stored in a structure of type ZPS_tsAplZdpStoreBkupBindEntryRsp(detailed in Section 9.2.3.27).

Parent topic:ZPS_eAplZdpStoreBkupBindEntryRequest

Parameters

hAPdu Handle of APDU in which request is sent.
uDstAddr Address of destination node of request (can be 16- or 64-bit, as specified by bExtAddr)
bExtAddr Type of destination address:
- TRUE: 64-bit IEEE (MAC) address
- FALSE: 16-bit network address
* pu8SeqNumber Pointer to sequence number of request
u16ProfileId Application profile ID
* psZdpStoreBkupBindEntryReq Pointer to request (see above)

Parent topic:ZPS_eAplZdpStoreBkupBindEntryRequest

Returns

ZPS_E_SUCCESS (request successfully sent)
APS return codes, listed and described in Section 11.2.2
NWK return codes, listed and described in Section 11.2.3
MAC return codes, listed and described in Section 11.2.4

Parent topic:ZPS_eAplZdpStoreBkupBindEntryRequest

Parent topic:Binding functions