com.smartdevicelink.protocol.ProtocolMessage Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdl_java_se Show documentation
Show all versions of sdl_java_se Show documentation
The app library component of SDL is meant to run on the end userâs smart-device from within SDL enabled apps, as an embedded app, or connected to the cloud. App libraries allow the apps to connect to SDL enabled head-units and hardware through bluetooth, USB, and TCP for Android, and cloud and embedded apps can connect through web sockets, Java Beans, and other custom transports. Once the library establishes a connection between the smart device and head-unit through the preferred method of transport, the two components are able to communicate using the SDL defined protocol. The app integrating this library project is then able to expose its functionality to the head-unit through text, media, and other interactive elements.
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.protocol;
import androidx.annotation.RestrictTo;
import com.smartdevicelink.protocol.enums.MessageType;
import com.smartdevicelink.protocol.enums.SessionType;
@RestrictTo(RestrictTo.Scope.LIBRARY)
public class ProtocolMessage {
private byte version = 1;
private SessionType _sessionType = SessionType.RPC;
private MessageType _messageType = MessageType.UNDEFINED;
private byte _sessionID = 0;
private byte _rpcType;
private int _functionID;
private int _correlationID;
private int _jsonSize;
private boolean payloadProtected = false;
int priorityCoefficient = 0;
private byte[] _data = null;
private byte[] _bulkData = null;
public ProtocolMessage() {
}
public byte getVersion() {
return version;
}
public void setVersion(byte version) {
this.version = version;
}
public byte getSessionID() {
return _sessionID;
}
public void setSessionID(byte sessionID) {
this._sessionID = sessionID;
}
public byte[] getData() {
return _data;
}
public void setData(byte[] data) {
this._data = data;
this._jsonSize = data.length;
}
public void setData(byte[] data, int length) {
setData(data, 0, length);
}
public void setData(byte[] data, int offset, int length) {
if (this._data != null)
this._data = null;
this._data = new byte[length];
System.arraycopy(data, offset, this._data, 0, length);
this._jsonSize = 0;
}
public byte[] getBulkData() {
return _bulkData;
}
public void setBulkDataNoCopy(byte[] bulkData) {
this._bulkData = bulkData;
}
public void setBulkData(byte[] bulkData) {
if (this._bulkData != null)
this._bulkData = null;
this._bulkData = new byte[bulkData.length];
System.arraycopy(bulkData, 0, this._bulkData, 0, bulkData.length);
//this._bulkData = bulkData;
}
public void setBulkData(byte[] bulkData, int length) {
if (this._bulkData != null)
this._bulkData = null;
this._bulkData = new byte[length];
System.arraycopy(bulkData, 0, this._bulkData, 0, length);
//this._bulkData = bulkData;
}
public SessionType getSessionType() {
return _sessionType;
}
public void setSessionType(SessionType sessionType) {
this._sessionType = sessionType;
}
public MessageType getMessageType() {
return _messageType;
}
public void setMessageType(MessageType messageType) {
this._messageType = messageType;
}
public byte getRPCType() {
return _rpcType;
}
public void setRPCType(byte _rpcType) {
this._rpcType = _rpcType;
}
public int getFunctionID() {
return _functionID;
}
public void setFunctionID(int _functionID) {
this._functionID = _functionID;
}
public int getCorrID() {
return _correlationID;
}
public void setCorrID(int _correlationID) {
this._correlationID = _correlationID;
}
public int getJsonSize() {
return _jsonSize;
}
public void setJsonSize(int _jsonSize) {
this._jsonSize = _jsonSize;
}
public void setPayloadProtected(boolean bVal) {
payloadProtected = bVal;
}
public boolean getPayloadProtected() {
return payloadProtected;
}
/**
* Set the priority for this packet. The lower the number the higher the priority.
0 is the highest priority and the default.
*
* @param priority the priority of this message
*/
public void setPriorityCoefficient(int priority) {
this.priorityCoefficient = priority;
}
@Deprecated
public int getPrioirtyCoefficient() {
return this.priorityCoefficient;
}
public int getPriorityCoefficient() {
return this.priorityCoefficient;
}
} // end-class
© 2015 - 2025 Weber Informatics LLC | Privacy Policy