jadex.base.relay

Class PlatformInfo

java.lang.Object

jadex.base.relay.PlatformInfo

public final class PlatformInfo
extends java.lang.Object

Data object to collect information about connected platforms.

Field Summary

Fields

Modifier and Type	Field and Description
protected jadex.bridge.service.types.awareness.AwarenessInfo	awainfo The awareness info (if any).
protected double	bytes_received The number of received bytes.
protected java.util.Date	connect_time The time when the connection was established.
protected java.lang.Integer	dbid The db id.
protected java.util.Date	disconnect_time The time when the connection was lost.
protected java.lang.String	hostip The host ip.
protected java.lang.String	hostname The host name.
protected jadex.commons.future.IFuture<java.lang.String>	hostnamefut The host name future for eager resolving.
protected java.lang.String	id The platform id.
protected int	msg_cnt The number of messages for the recipient.
protected jadex.bridge.service.types.message.ICodec[]	pcodecs The preferred codecs (if any).
protected java.lang.String	peerid The peer id.
protected java.util.Map<java.lang.String,java.lang.String>	properties The properties (if any).
protected java.lang.String	scheme The protocol (e.g.
static java.lang.ThreadLocal<java.text.DateFormat>	TIME_FORMAT_LONG The long time format (time and date).
static java.lang.ThreadLocal<java.text.DateFormat>	TIME_FORMAT_SHORT The short time format (only time).
protected double	total_transmission_time The accumulated time spent for transmitting data (millis).

Constructor Summary

Constructors

Constructor and Description
PlatformInfo() Create a platform info.
PlatformInfo(java.lang.Integer dbid, java.lang.String peerid, java.lang.String id, java.lang.String hostip, java.lang.String hostname, java.lang.String protocol, java.util.Date connect_time, java.util.Date disconnect_time, int msg_cnt, double bytes_received, double total_transmission_time) Constructor used by db.
PlatformInfo(java.lang.String id, java.lang.String peerid, java.lang.String hostip, java.lang.String hostname, java.lang.String protocol) Create a platform info.

Method Summary

Modifier and Type	Method and Description
void	addMessage(int bytes, long time) Add a sent message.
void	disconnect() Platform has disconnected.
jadex.bridge.service.types.awareness.AwarenessInfo	getAwarenessInfo() Get the awareness info.
java.lang.String	getByteCount() Get the byte count as beautified string.
double	getBytes() Get the byte count as raw value
java.util.Date	getConnectDate() Get the connect date.
java.lang.String	getConnectTime() Get the connect time.
java.lang.String	getCountryCode() Get the country code (e.g.
java.lang.Integer	getDBId() Get the db id
java.util.Date	getDisconnectDate() Get the disconnect date.
java.lang.String	getDisconnectTime() Get the disconnect time.
java.lang.String	getHostIP() Get the host.
java.lang.String	getHostName() Get the resolved host name.
java.lang.String	getId() Get the id.
java.lang.String	getLocation() Get the location (i.e.
int	getMessageCount() Get the message count.
java.lang.String	getPeerId() Get the peer id
java.lang.String	getPosition() Get the location as latitude,longitude.
jadex.bridge.service.types.message.ICodec[]	getPreferredCodecs() Get the preferred codecs.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Get the properties.
java.lang.String	getScheme() Get the host.
java.lang.String	getTransferRate() Get the average transfer rate as beautified string.
double	getTransferTime() Get the transfer time as raw value (millis).
void	reconnect(java.lang.String hostip, java.lang.String hostname) Platform with same id has reconnected.
void	setAwarenessInfo(jadex.bridge.service.types.awareness.AwarenessInfo awainfo) Set the awareness info.
void	setConnectDate(java.util.Date contime) Set the connect time.
void	setDBId(java.lang.Integer dbid) Set db id
void	setDisconnectDate(java.util.Date distime) Set the disconnect time.
void	setHostIP(java.lang.String hostip) Set the host ip.
void	setHostName(java.lang.String hostname) Set the host name.
void	setId(java.lang.String id) The the platform id.
void	setPeerId(java.lang.String peerid) Set the peer id
void	setPreferredCodecs(jadex.bridge.service.types.message.ICodec[] pcodecs) Set the preferred codecs.
void	setProperties(java.util.Map<java.lang.String,java.lang.String> props) Set the properties.
java.lang.String	toString() Create a string representation.

Methods inherited from class java.lang.Object

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

Field Detail

TIME_FORMAT_SHORT

public static final java.lang.ThreadLocal<java.text.DateFormat> TIME_FORMAT_SHORT

The short time format (only time).

TIME_FORMAT_LONG

public static final java.lang.ThreadLocal<java.text.DateFormat> TIME_FORMAT_LONG

The long time format (time and date).

dbid

protected java.lang.Integer dbid

The db id.

id

protected java.lang.String id

The platform id.

peerid

protected java.lang.String peerid

The peer id.

hostip

protected java.lang.String hostip

The host ip.

hostname

protected java.lang.String hostname

The host name.

hostnamefut

protected jadex.commons.future.IFuture<java.lang.String> hostnamefut

The host name future for eager resolving.

scheme

protected java.lang.String scheme

The protocol (e.g. http or https).

connect_time

protected java.util.Date connect_time

The time when the connection was established.

disconnect_time

protected java.util.Date disconnect_time

The time when the connection was lost.

bytes_received

protected double bytes_received

The number of received bytes.

total_transmission_time

protected double total_transmission_time

The accumulated time spent for transmitting data (millis).

msg_cnt

protected int msg_cnt

The number of messages for the recipient.

awainfo

protected jadex.bridge.service.types.awareness.AwarenessInfo awainfo

The awareness info (if any).

pcodecs

protected jadex.bridge.service.types.message.ICodec[] pcodecs

The preferred codecs (if any).

properties

protected java.util.Map<java.lang.String,java.lang.String> properties

The properties (if any).

Constructor Detail

PlatformInfo

public PlatformInfo()

Create a platform info.

PlatformInfo

public PlatformInfo(java.lang.String id,
                    java.lang.String peerid,
                    java.lang.String hostip,
                    java.lang.String hostname,
                    java.lang.String protocol)

Create a platform info.

PlatformInfo

public PlatformInfo(java.lang.Integer dbid,
                    java.lang.String peerid,
                    java.lang.String id,
                    java.lang.String hostip,
                    java.lang.String hostname,
                    java.lang.String protocol,
                    java.util.Date connect_time,
                    java.util.Date disconnect_time,
                    int msg_cnt,
                    double bytes_received,
                    double total_transmission_time)

Constructor used by db.

Method Detail

getId

public java.lang.String getId()

Get the id.

getHostIP

public java.lang.String getHostIP()

Get the host.

getHostName

public java.lang.String getHostName()

Get the resolved host name.

getScheme

public java.lang.String getScheme()

Get the host.

getConnectTime

public java.lang.String getConnectTime()

Get the connect time.

getDisconnectTime

public java.lang.String getDisconnectTime()

Get the disconnect time.

getConnectDate

public java.util.Date getConnectDate()

Get the connect date.

getDisconnectDate

public java.util.Date getDisconnectDate()

Get the disconnect date.

getMessageCount

public int getMessageCount()

Get the message count.

getByteCount

public java.lang.String getByteCount()

Get the byte count as beautified string.

getBytes

public double getBytes()

Get the byte count as raw value

getTransferRate

public java.lang.String getTransferRate()

Get the average transfer rate as beautified string.

getTransferTime

public double getTransferTime()

Get the transfer time as raw value (millis).

getAwarenessInfo

public jadex.bridge.service.types.awareness.AwarenessInfo getAwarenessInfo()

Get the awareness info.

getDBId

public java.lang.Integer getDBId()

Get the db id

getPeerId

public java.lang.String getPeerId()

Get the peer id

getLocation

public java.lang.String getLocation()

Get the location (i.e. city, region, country). Dynamically resolved by GeoIP, if available.

getCountryCode

public java.lang.String getCountryCode()

Get the country code (e.g. de, us, ...). Dynamically resolved by GeoIP, if available.

getPosition

public java.lang.String getPosition()

Get the location as latitude,longitude.

addMessage

public void addMessage(int bytes,
                       long time)

Add a sent message.

Parameters:

bytes - The number of bytes sent.

time - The time required for sending (nanos).

reconnect

public void reconnect(java.lang.String hostip,
                      java.lang.String hostname)

Platform with same id has reconnected.

disconnect

public void disconnect()

Platform has disconnected.

setAwarenessInfo

public void setAwarenessInfo(jadex.bridge.service.types.awareness.AwarenessInfo awainfo)

Set the awareness info.

setDBId

public void setDBId(java.lang.Integer dbid)

Set db id

setPeerId

public void setPeerId(java.lang.String peerid)

Set the peer id

setId

public void setId(java.lang.String id)

The the platform id.

toString

public java.lang.String toString()

Create a string representation.

Overrides:

toString in class java.lang.Object

setDisconnectDate

public void setDisconnectDate(java.util.Date distime)

Set the disconnect time.

setConnectDate

public void setConnectDate(java.util.Date contime)

Set the connect time.

setHostIP

public void setHostIP(java.lang.String hostip)

Set the host ip.

setHostName

public void setHostName(java.lang.String hostname)

Set the host name.

getPreferredCodecs

public jadex.bridge.service.types.message.ICodec[] getPreferredCodecs()

Get the preferred codecs. The relay server will send awareness infos to the platform using this codecs.

setPreferredCodecs

public void setPreferredCodecs(jadex.bridge.service.types.message.ICodec[] pcodecs)

Set the preferred codecs. The relay server will send awareness infos to the platform using this codecs.

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

Get the properties. Properies are copied from awareness info, if any, to save properties to db, while awareness info isn't saved.

Returns:

The properties, if any.

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> props)

Set the properties. Properies are copied from awareness info, if any, to save properties to db, while awareness info isn't saved.

Parameters:

props - The properties.