org.osgi.service.zigbee

Interface ZDPFrame

public interface ZDPFrame

This interface represents a ZDP frame.

See Figure 2.19 Format of the ZDP Frame ZIGBEE SPECIFICATION: 1_053474r17ZB_TSC-ZigBee-Specification.pdf.

This interface MUST be implemented by the developer invoking the ZigBeeNode.invoke(int, int, ZDPFrame) method.

Notes:

• This interface hides on purpose the Transaction Sequence Number field because it MUST be handled internally by the ZigBee Base Driver
• The interface does not provide any method for writing the payload because the ZigBee Base Driver needs only to read the payload.

Method Summary

Modifier and Type	Method and Description
ZigBeeDataInput	getDataInput() Returns the ZigBeeDataInput of the payload of this frame.
byte[]	getPayload() Returns a copy of the payload of this frame.

Method Detail

getPayload

byte[] getPayload()

Returns a copy of the payload of this frame.

Returns:

A copy of the payload of this frame.

getDataInput

ZigBeeDataInput getDataInput()

Returns the ZigBeeDataInput of the payload of this frame.

Returns:

the ZigBeeDataInput of the payload of the ZDPFrame. This method, in contrary to getPayload(), doesn't require to create a copy of the payload.

Throws:

IllegalStateException - if a ZigBeeDataInput stream cannot be returned because the underlying ZDPFrame implementation was not correctly initialized.