Method FromPayload

Namespace

Bonsai.Harp

Assembly

Bonsai.Harp.dll

FromPayload(int, MessageType, PayloadType, params byte[])

Returns a HarpMessage with the specified address, message type, and payload.

public static HarpMessage FromPayload(int address, MessageType messageType, PayloadType payloadType, params byte[] payload)

Parameters

address int

The address of the register to which the Harp message refers to.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload byte[]

The raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type and payload.

FromPayload(int, int, MessageType, PayloadType, params byte[])

Returns a HarpMessage with the specified address, message type, port, and payload.

public static HarpMessage FromPayload(int address, int port, MessageType messageType, PayloadType payloadType, params byte[] payload)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload byte[]

The raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, and payload.

FromPayload(int, MessageType, PayloadType, ArraySegment<byte>)

Returns a HarpMessage with the specified address, message type, and payload data stored in the specified array segment.

public static HarpMessage FromPayload(int address, MessageType messageType, PayloadType payloadType, ArraySegment<byte> payload)

Parameters

address int

The address of the register to which the Harp message refers to.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload ArraySegment<byte>

An array segment containing the raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, and payload.

FromPayload(int, int, MessageType, PayloadType, ArraySegment<byte>)

Returns a HarpMessage with the specified address, message type, port, and payload data stored in the specified array segment.

public static HarpMessage FromPayload(int address, int port, MessageType messageType, PayloadType payloadType, ArraySegment<byte> payload)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload ArraySegment<byte>

An array segment containing the raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, and payload.

FromPayload(int, double, MessageType, PayloadType, params byte[])

Returns a HarpMessage with the specified address, message type, timestamp, and payload.

public static HarpMessage FromPayload(int address, double timestamp, MessageType messageType, PayloadType payloadType, params byte[] payload)

Parameters

address int

The address of the register to which the Harp message refers to.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload byte[]

The raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, timestamp, and payload.

FromPayload(int, int, double, MessageType, PayloadType, params byte[])

Returns a HarpMessage with the specified address, message type, port, timestamp, and payload.

public static HarpMessage FromPayload(int address, int port, double timestamp, MessageType messageType, PayloadType payloadType, params byte[] payload)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload byte[]

The raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, timestamp, and payload.

FromPayload(int, double, MessageType, PayloadType, ArraySegment<byte>)

Returns a HarpMessage with the specified address, message type, timestamp, and payload data stored in the specified array segment.

public static HarpMessage FromPayload(int address, double timestamp, MessageType messageType, PayloadType payloadType, ArraySegment<byte> payload)

Parameters

address int

The address of the register to which the Harp message refers to.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload ArraySegment<byte>

An array segment containing the raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, timestamp, and payload.

FromPayload(int, int, double, MessageType, PayloadType, ArraySegment<byte>)

Returns a HarpMessage with the specified address, message type, port, timestamp, and payload data stored in the specified array segment.

public static HarpMessage FromPayload(int address, int port, double timestamp, MessageType messageType, PayloadType payloadType, ArraySegment<byte> payload)

Parameters

address int

The address of the register to which the Harp message refers to.

port int

The origin or destination of the Harp message, for routing purposes.

timestamp double

The timestamp of the message payload, in seconds.

messageType MessageType

The type of the Harp message.

payloadType PayloadType

The type of data available in the message payload.

payload ArraySegment<byte>

An array segment containing the raw binary representation of the payload data.

Returns

HarpMessage

A valid HarpMessage instance with the specified address, message type, port, timestamp, and payload.