jremote jbase5.2.1

com.jbase.jremote.io
Class JbaseMsg

java.lang.Object
  extended by com.jbase.jremote.io.JbaseMsg

public abstract class JbaseMsg
extends Object

jBASE Socket message

This is the base message class for jBASE messages. This class has knowledge of the format of message required to communicate with the jBASE socket server.

Header + Buffer

.-------------------------------+-------------------------------. | Total Length | Magic number | | (4 bytes signed int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | Function | Error code | | (4 bytes signed int) | (4 bytes signed int) | |-------------------------------+-------------------------------| | User 0 | User 1 | | (4 bytes unsigned int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | User 2 | User 3 | | (4 bytes unsigned int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | User 4 | User 5 | | (4 bytes unsigned int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | User 6 | User 7 | | (4 bytes unsigned int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | User 8 | User 9 | | (4 bytes unsigned int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | User 10 | User 11 | | (4 bytes unsigned int) | (4 bytes unsigned int) | |-------------------------------+-------------------------------| | Buffer length | Data length | | (4 bytes signed int) | (4 bytes signed int) | |---------------------------------------------------------------| | Buffer * (see buffer length, to a maximum of 2000 bytes) | `---------------------------------------------------------------'

Data

.-------------------------------+-------------------------------. | Data * (see data length) | `---------------------------------------------------------------'

Author:
aphethean

Constructor Summary
JbaseMsg()
           
JbaseMsg(byte[] message)
           
 
Method Summary
protected  void construct(byte[] message)
           
abstract  byte[] getBuffer()
           
abstract  byte[] getData()
           
 int getDataLength()
           
abstract  int getError()
           
abstract  int getFunction()
           
abstract  int getMagic()
           
abstract  int getUser0()
           
abstract  int getUser1()
           
abstract  int getUser10()
           
abstract  int getUser11()
           
abstract  int getUser2()
           
abstract  int getUser3()
           
abstract  int getUser4()
           
abstract  int getUser5()
           
abstract  int getUser6()
           
abstract  int getUser7()
           
abstract  int getUser8()
           
abstract  int getUser9()
           
abstract  void setBuffer(byte[] buffer)
           
abstract  void setData(byte[] data)
           
 void setDataLength(int length)
           
abstract  void setError(int e)
           
abstract  void setFunction(int f)
           
abstract  void setMagic(int m)
           
abstract  void setUser0(int u)
           
abstract  void setUser1(int u)
           
abstract  void setUser10(int u)
           
abstract  void setUser11(int u)
           
abstract  void setUser2(int u)
           
abstract  void setUser3(int u)
           
abstract  void setUser4(int u)
           
abstract  void setUser5(int u)
           
abstract  void setUser6(int u)
           
abstract  void setUser7(int u)
           
abstract  void setUser8(int u)
           
abstract  void setUser9(int u)
           
protected  byte[] toBytes()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JbaseMsg

public JbaseMsg()

JbaseMsg

public JbaseMsg(byte[] message)
Method Detail

getMagic

public abstract int getMagic()

getFunction

public abstract int getFunction()

getError

public abstract int getError()

getUser0

public abstract int getUser0()

getUser1

public abstract int getUser1()

getUser2

public abstract int getUser2()

getUser3

public abstract int getUser3()

getUser4

public abstract int getUser4()

getUser5

public abstract int getUser5()

getUser6

public abstract int getUser6()

getUser7

public abstract int getUser7()

getUser8

public abstract int getUser8()

getUser9

public abstract int getUser9()

getUser10

public abstract int getUser10()

getUser11

public abstract int getUser11()

getBuffer

public abstract byte[] getBuffer()

getData

public abstract byte[] getData()

setMagic

public abstract void setMagic(int m)

setFunction

public abstract void setFunction(int f)

setError

public abstract void setError(int e)

setUser0

public abstract void setUser0(int u)

setUser1

public abstract void setUser1(int u)

setUser2

public abstract void setUser2(int u)

setUser3

public abstract void setUser3(int u)

setUser4

public abstract void setUser4(int u)

setUser5

public abstract void setUser5(int u)

setUser6

public abstract void setUser6(int u)

setUser7

public abstract void setUser7(int u)

setUser8

public abstract void setUser8(int u)

setUser9

public abstract void setUser9(int u)

setUser10

public abstract void setUser10(int u)

setUser11

public abstract void setUser11(int u)

setBuffer

public abstract void setBuffer(byte[] buffer)

setData

public abstract void setData(byte[] data)

setDataLength

public void setDataLength(int length)

getDataLength

public int getDataLength()

toBytes

protected byte[] toBytes()

construct

protected void construct(byte[] message)

jremote jbase5.2.1

Copyright © 2016 TEMENOS. All Rights Reserved.