com.smartdevicelink.protocol

Class SdlPacket

java.lang.Object

com.smartdevicelink.protocol.SdlPacket

All Implemented Interfaces:

Parcelable

public class SdlPacket
extends Object
implements Parcelable

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<SdlPacket>	CREATOR
static int	FRAME_INFO_END_SERVICE
static int	FRAME_INFO_END_SERVICE_ACK
static int	FRAME_INFO_END_SERVICE_NAK
static int	FRAME_INFO_FINAL_CONNESCUTIVE_FRAME
static int	FRAME_INFO_HEART_BEAT
static int	FRAME_INFO_HEART_BEAT_ACK
static int	FRAME_INFO_REGISTER_SECONDARY_TRANSPORT
static int	FRAME_INFO_REGISTER_SECONDARY_TRANSPORT_ACK
static int	FRAME_INFO_REGISTER_SECONDARY_TRANSPORT_NAK
static int	FRAME_INFO_RESERVED
static int	FRAME_INFO_SERVICE_DATA_ACK
static int	FRAME_INFO_START_SERVICE
static int	FRAME_INFO_START_SERVICE_ACK
static int	FRAME_INFO_START_SERVICE_NAK
static int	FRAME_INFO_TRANSPORT_EVENT_UPDATE
static int	FRAME_TYPE_CONSECUTIVE
static int	FRAME_TYPE_CONTROL
static int	FRAME_TYPE_FIRST
static int	FRAME_TYPE_SINGLE
static int	HEADER_SIZE
static int	HEADER_SIZE_V1
static int	SERVICE_TYPE_BULK_DATA
static int	SERVICE_TYPE_CONTROL
static int	SERVICE_TYPE_PCM
static int	SERVICE_TYPE_RPC
static int	SERVICE_TYPE_VIDEO

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SdlPacket()
protected	SdlPacket(com.smartdevicelink.protocol.BaseSdlPacket packet)
	SdlPacket(int version, boolean encryption, int frameType, int serviceType, int frameInfo, int sessionId, int dataSize, int messageId, byte[] payload)
	SdlPacket(int version, boolean encryption, int frameType, int serviceType, int frameInfo, int sessionId, int dataSize, int messageId, byte[] payload, int offset, int bytesToWrite)
	SdlPacket(Parcel p)

Method Summary

Modifier and Type	Method and Description
byte[]	constructPacket()
static byte[]	constructPacket(int version, boolean encryption, int frameType, int serviceType, int controlFrameInfo, int sessionId, int dataSize, int messageId, byte[] payload) This method takes in the various components to the SDL packet structure and creates a new byte array that can be sent via the transport
int	describeContents()
long	getDataSize()
static int	getEncryptionBit(boolean encryption)
int	getFrameInfo()
FrameType	getFrameType()
int	getMessageId()
byte[]	getPayload()
int	getPrioirtyCoefficient() Deprecated.
int	getPriorityCoefficient()
int	getServiceType()
int	getSessionId()
Object	getTag(String tag)
TransportRecord	getTransportRecord()
int	getVersion()
boolean	isEncrypted()
void	putTag(String tag, Object data)
void	setMessagingVersion(int version)
void	setPayload(byte[] bytes)
void	setPriorityCoefficient(int priority) Set the priority for this packet.
void	setTransportRecord(TransportRecord transportRecord)
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<SdlPacket> CREATOR

HEADER_SIZE

public static final int HEADER_SIZE

See Also:

Constant Field Values

HEADER_SIZE_V1

public static final int HEADER_SIZE_V1

See Also:

Constant Field Values

FRAME_TYPE_CONTROL

public static final int FRAME_TYPE_CONTROL

See Also:

Constant Field Values

FRAME_TYPE_SINGLE

public static final int FRAME_TYPE_SINGLE

See Also:

Constant Field Values

FRAME_TYPE_FIRST

public static final int FRAME_TYPE_FIRST

See Also:

Constant Field Values

FRAME_TYPE_CONSECUTIVE

public static final int FRAME_TYPE_CONSECUTIVE

See Also:

Constant Field Values

SERVICE_TYPE_CONTROL

public static final int SERVICE_TYPE_CONTROL

See Also:

Constant Field Values

SERVICE_TYPE_RPC

public static final int SERVICE_TYPE_RPC

See Also:

Constant Field Values

SERVICE_TYPE_PCM

public static final int SERVICE_TYPE_PCM

See Also:

Constant Field Values

SERVICE_TYPE_VIDEO

public static final int SERVICE_TYPE_VIDEO

See Also:

Constant Field Values

SERVICE_TYPE_BULK_DATA

public static final int SERVICE_TYPE_BULK_DATA

See Also:

Constant Field Values

FRAME_INFO_HEART_BEAT

public static final int FRAME_INFO_HEART_BEAT

See Also:

Constant Field Values

FRAME_INFO_START_SERVICE

public static final int FRAME_INFO_START_SERVICE

See Also:

Constant Field Values

FRAME_INFO_START_SERVICE_ACK

public static final int FRAME_INFO_START_SERVICE_ACK

See Also:

Constant Field Values

FRAME_INFO_START_SERVICE_NAK

public static final int FRAME_INFO_START_SERVICE_NAK

See Also:

Constant Field Values

FRAME_INFO_END_SERVICE

public static final int FRAME_INFO_END_SERVICE

See Also:

Constant Field Values

FRAME_INFO_END_SERVICE_ACK

public static final int FRAME_INFO_END_SERVICE_ACK

See Also:

Constant Field Values

FRAME_INFO_END_SERVICE_NAK

public static final int FRAME_INFO_END_SERVICE_NAK

See Also:

Constant Field Values

FRAME_INFO_REGISTER_SECONDARY_TRANSPORT

public static final int FRAME_INFO_REGISTER_SECONDARY_TRANSPORT

See Also:

Constant Field Values

FRAME_INFO_REGISTER_SECONDARY_TRANSPORT_ACK

public static final int FRAME_INFO_REGISTER_SECONDARY_TRANSPORT_ACK

See Also:

Constant Field Values

FRAME_INFO_REGISTER_SECONDARY_TRANSPORT_NAK

public static final int FRAME_INFO_REGISTER_SECONDARY_TRANSPORT_NAK

See Also:

Constant Field Values

FRAME_INFO_TRANSPORT_EVENT_UPDATE

public static final int FRAME_INFO_TRANSPORT_EVENT_UPDATE

See Also:

Constant Field Values

FRAME_INFO_SERVICE_DATA_ACK

public static final int FRAME_INFO_SERVICE_DATA_ACK

See Also:

Constant Field Values

FRAME_INFO_HEART_BEAT_ACK

public static final int FRAME_INFO_HEART_BEAT_ACK

See Also:

Constant Field Values

FRAME_INFO_FINAL_CONNESCUTIVE_FRAME

public static final int FRAME_INFO_FINAL_CONNESCUTIVE_FRAME

See Also:

Constant Field Values

FRAME_INFO_RESERVED

public static final int FRAME_INFO_RESERVED

See Also:

Constant Field Values

Constructor Detail

SdlPacket

public SdlPacket(int version,
                 boolean encryption,
                 int frameType,
                 int serviceType,
                 int frameInfo,
                 int sessionId,
                 int dataSize,
                 int messageId,
                 byte[] payload)

SdlPacket

public SdlPacket(int version,
                 boolean encryption,
                 int frameType,
                 int serviceType,
                 int frameInfo,
                 int sessionId,
                 int dataSize,
                 int messageId,
                 byte[] payload,
                 int offset,
                 int bytesToWrite)

SdlPacket

protected SdlPacket()

SdlPacket

protected SdlPacket(com.smartdevicelink.protocol.BaseSdlPacket packet)

SdlPacket

public SdlPacket(Parcel p)

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getVersion

public int getVersion()

isEncrypted

public boolean isEncrypted()

getFrameType

public FrameType getFrameType()

getServiceType

public int getServiceType()

getFrameInfo

public int getFrameInfo()

getSessionId

public int getSessionId()

getMessageId

public int getMessageId()

getDataSize

public long getDataSize()

getPayload

public byte[] getPayload()

constructPacket

public byte[] constructPacket()

setPayload

public void setPayload(byte[] bytes)

setPriorityCoefficient

public void setPriorityCoefficient(int priority)

Set the priority for this packet. The lower the number the higher the priority.
0 is the highest priority and the default.

Parameters:

priority - the priority of this packet

getPrioirtyCoefficient

@Deprecated
public int getPrioirtyCoefficient()

Deprecated.

getPriorityCoefficient

public int getPriorityCoefficient()

setTransportRecord

public void setTransportRecord(TransportRecord transportRecord)

getTransportRecord

public TransportRecord getTransportRecord()

constructPacket

public static byte[] constructPacket(int version,
                                     boolean encryption,
                                     int frameType,
                                     int serviceType,
                                     int controlFrameInfo,
                                     int sessionId,
                                     int dataSize,
                                     int messageId,
                                     byte[] payload)

This method takes in the various components to the SDL packet structure and creates a new byte array that can be sent via the transport

Parameters:

version - protocol version to use

encryption - whether or not this packet is encrypted

frameType - the packet frame type

serviceType - the service that this packet is associated with

controlFrameInfo - specific frame info related to this packet

sessionId - ID this packet is associated with

dataSize - size of the payload that will be added

messageId - ID of this specific packet

payload - raw data that will be attached to the packet (RPC message, raw bytes, etc)

Returns:

a byte[] representation of an SdlPacket built using the supplied params

getEncryptionBit

public static int getEncryptionBit(boolean encryption)

toString

public String toString()

Overrides:

toString in class Object

setMessagingVersion

public void setMessagingVersion(int version)

putTag

public void putTag(String tag,
                   Object data)

getTag

public Object getTag(String tag)