Package com.kosdev.kos.commons.core.client.binarymsg

Class BinaryMsgClient

java.lang.Object

com.kosdev.kos.commons.core.client.binarymsg.BinaryMsgClient

public class BinaryMsgClient
extends Object

Client for BinaryMsg protocol. Allows adapter simulators to be written in java.

Since:

1

Version:

1

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_PORT
static final String	DEFAULT_SERVER

Constructor Summary

Constructors

Constructor	Description
BinaryMsgClient(String blinkName, BinaryMsgIdentity identity, String server, int port)	Create a new client.

Method Summary

Modifier and Type	Method	Description
void	addBoardIface(String type, String instanceId, String identity, String mfgSerialNum)	Add Board iface with the specified board info.
void	addIface(BinaryMsgClientIface iface)	Add a new iface to the client.
ByteOrder	getByteOrder()	Get the byte order of the client.
BinaryMsgClientIface	getCoreIface()
boolean	isEnabled()	Return true if the client is enabled.
void	send(BinaryMsg msg)	Send a message to the remote side of the connection.
void	setEnabled(boolean enabled)	Enable the client.
void	start()	Connect to the server and start processing messages.
void	stop()	Disconnect from the server.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_SERVER

public static final String DEFAULT_SERVER

See Also:

• Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

• Constant Field Values

Constructor Details

BinaryMsgClient

public BinaryMsgClient(String blinkName,
 BinaryMsgIdentity identity,
 String server,
 int port)

Create a new client.

Parameters:

blinkName - name of the blink connection

identity - the identity to send, null for default

server - server address, null for localhost

port - server port, 0 for default

Since:

1

Method Details

getByteOrder

public ByteOrder getByteOrder()

Get the byte order of the client.

Since:

1

addIface

public void addIface(BinaryMsgClientIface iface)

Add a new iface to the client.

Since:

1

addBoardIface

public void addBoardIface(String type,
 String instanceId,
 String identity,
 String mfgSerialNum)

Add Board iface with the specified board info.

Parameters:

type - board type

instanceId - instance of the board

identity - unique identifier such as mac addr or serial num

mfgSerialNum - serial number if available

setEnabled

public void setEnabled(boolean enabled)

Enable the client. This simply calls start() or stop() based on the provided value.

Parameters:

enabled - true to start the client, false to stop it

isEnabled

public boolean isEnabled()

Return true if the client is enabled. This returns true if the client has been started.

start

public void start()

Connect to the server and start processing messages.

Since:

1

stop

public void stop()

Disconnect from the server.

Since:

1

send

public void send(BinaryMsg msg)
          throws IOException

Send a message to the remote side of the connection.

Parameters:

msg - the message to send

Throws:

IOException

Since:

1

getCoreIface

public BinaryMsgClientIface getCoreIface()