MessageCodec (IBM Watson IoT SDK 0.1.0 API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

JsonCodec, Utf8Codec
```
public interface MessageCodec<T>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`MessageInterface<T>`	`decode(org.eclipse.paho.client.mqttv3.MqttMessage msg)` Convert an MQTT message into an instance of com.ibm.wiotp.sdk.Message
`byte[]`	`encode(T data, org.joda.time.DateTime timestamp)` Convert an Object into a byte array suitable to send via MQTT
`Class<T>`	`getMessageClass()`
`String`	`getMessageFormat()`

- Method Detail
  - encode
```
byte[] encode(T data,
              org.joda.time.DateTime timestamp)
```
    Convert an Object into a byte array suitable to send via MQTT
    
    Parameters:
    
    data - the Object to be encoded
    
    timestamp - the time that the message was generated
    
    Returns:
    
    Byte array ready for MQTT message payload
  - decode
```
MessageInterface<T> decode(org.eclipse.paho.client.mqttv3.MqttMessage msg)
                    throws MalformedMessageException
```
    Convert an MQTT message into an instance of com.ibm.wiotp.sdk.Message
    
    Parameters:
    
    msg - the MqttMessage from Paho MQTT client to decode
    
    Returns:
    
    Object of class T from the decoded MQTT message
    
    Throws:
    
    MalformedMessageException - If unable to decode the message
  - getMessageClass
```
Class<T> getMessageClass()
```
  - getMessageFormat
```
String getMessageFormat()
```