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

Class BinaryMsgClientIface

java.lang.Object

com.tccc.kos.commons.core.client.binarymsg.BinaryMsgClientIface

public class BinaryMsgClientIface
extends Object

Handler interface to register with a BinaryMsgClient.

Since:

1.0

Version:

2023-12-16

Constructor Summary

Constructors

Constructor	Description
BinaryMsgClientIface(String name, int version)	Create a client iface with the specified name.

Method Summary

Modifier and Type	Method	Description
void	addHandler(int apiNum, BinaryMsgClientHandler handler)	Register a handler with the specified api num.
String	getName()
int	getVersion()
BinaryMsg	msg(int apiNum)	Create a new BinaryMsg with the specified api number.
void	setVersion(int version)

Methods inherited from class java.lang.Object

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

Constructor Details

BinaryMsgClientIface

public BinaryMsgClientIface(String name,
 int version)

Create a client iface with the specified name.

Parameters:

name - name of the iface

version - iface version

Method Details

addHandler

public void addHandler(int apiNum,
 BinaryMsgClientHandler handler)

Register a handler with the specified api num.

Parameters:

apiNum - the api number the hanlder is for

handler - the handler to process messages

msg

public BinaryMsg msg(int apiNum)

Create a new BinaryMsg with the specified api number.

Parameters:

apiNum - the api number for the message

getName

public String getName()

getVersion

public int getVersion()

setVersion

public void setVersion(int version)