PeerHandler (jadex-platform-extension-relay 3.0.0-RC16 API)

java.lang.Object
- jadex.base.relay.PeerHandler

All Implemented Interfaces:

java.lang.Runnable
```
public class PeerHandler
extends java.lang.Object
implements java.lang.Runnable
```
Handler to periodically ping remote peer and synchronize history db.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`connected` Is this peer connected?
`protected java.lang.String`	`debugtext` Debug information as multi-line xml text.
`static long`	`DELAY_OFFLINE` Delay between two pings when a peer is offline.
`static long`	`DELAY_ONLINE` Delay between two pings when a peer is connected.
`protected RelayHandler`	`handler` The relay handler.
`protected java.util.Map<java.lang.String,PlatformInfo>`	`infos` The current platform infos received from the peer (platform id->info).
`protected boolean`	`initial` Is the peer one of the initial peers?
`protected java.lang.String`	`peerid` The peer id (null, if unknown).
`protected int`	`peerstate` The latest known remote peer state (-1 for none).
`protected boolean`	`sent` Have initial platform infos been sent already?
`protected boolean`	`shutdown` The shutdown flag.
`protected java.lang.String`	`url` The URL of the peer.

Constructor Summary

Constructors
Constructor and Description

PeerHandler(RelayHandler handler, java.lang.String url, boolean initial)
Create a timer task.

Constructors
Constructor and Description
`PeerHandler(RelayHandler handler, java.lang.String url, boolean initial)` Create a timer task.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDebugText(int level, java.lang.String msg)` Add a debug message.
`boolean`	`checkPlatform(java.lang.String id)` Check if a platform is connected to this peer.
`void`	`clearPlatformInfos()` Clear the list of platform infos.
`java.lang.String`	`getCountryCode()` Get the country code (e.g.
`java.lang.String`	`getDebugText()` Get the debug text.
`java.lang.String`	`getHost()` Get the host name of the peer server.
`java.lang.String`	`getLocation()` Get the location (i.e.
`PlatformInfo[]`	`getPlatformInfos()` Get the platform infos received from the peer.
`java.lang.String`	`getPosition()` Get the location as latitude,longitude.
`java.lang.String`	`getUrl()` Get the peer url.
`boolean`	`isConnected()` Check if the peer is connected.
`boolean`	`isInitial()` Check if the peer is an initial peer.
`boolean`	`isSent()` Check if awareness infos have bneen sent.
`protected void`	`peerOffline()` Called when a peer becomes offline.
`protected void`	`peerOnline()` Called when the peer becomes online.
`void`	`run()` Execute the handler.
`void`	`setConnected(boolean connected)` Set the connection state of the peer.
`void`	`setPeerState(java.lang.String peerid, int peerstate)` Set the peer state received from remote.
`void`	`setSent(boolean sent)` Set the sent state of the peer.
`void`	`shutdown()` Shutdown the handler.
`void`	`updatePlatformInfo(PlatformInfo info)` Update the platform info.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DELAY_ONLINE
```
public static final long DELAY_ONLINE
```
    Delay between two pings when a peer is connected.
    
    See Also:
    
    Constant Field Values
  - DELAY_OFFLINE
```
public static final long DELAY_OFFLINE
```
    Delay between two pings when a peer is offline.
    
    See Also:
    
    Constant Field Values
  - handler
```
protected RelayHandler handler
```
    The relay handler.
  - url
```
protected java.lang.String url
```
    The URL of the peer.
  - initial
```
protected boolean initial
```
    Is the peer one of the initial peers?
  - connected
```
protected boolean connected
```
    Is this peer connected?
  - infos
```
protected java.util.Map<java.lang.String,PlatformInfo> infos
```
    The current platform infos received from the peer (platform id->info).
  - sent
```
protected boolean sent
```
    Have initial platform infos been sent already?
  - debugtext
```
protected java.lang.String debugtext
```
    Debug information as multi-line xml text.
  - peerid
```
protected java.lang.String peerid
```
    The peer id (null, if unknown).
  - peerstate
```
protected int peerstate
```
    The latest known remote peer state (-1 for none).
  - shutdown
```
protected boolean shutdown
```
    The shutdown flag.
- Constructor Detail
  - PeerHandler
```
public PeerHandler(RelayHandler handler,
                   java.lang.String url,
                   boolean initial)
```
    Create a timer task.
- Method Detail
  - getUrl
```
public java.lang.String getUrl()
```
    Get the peer url.
  - setSent
```
public void setSent(boolean sent)
```
    Set the sent state of the peer.
  - setConnected
```
public void setConnected(boolean connected)
```
    Set the connection state of the peer.
  - isConnected
```
public boolean isConnected()
```
    Check if the peer is connected.
  - isSent
```
public boolean isSent()
```
    Check if awareness infos have bneen sent.
  - isInitial
```
public boolean isInitial()
```
    Check if the peer is an initial peer. Initial peers are not removed from the list, even when currently offline.
  - updatePlatformInfo
```
public void updatePlatformInfo(PlatformInfo info)
```
    Update the platform info. If the platform is offline, the info is removed.
  - getPlatformInfos
```
public PlatformInfo[] getPlatformInfos()
```
    Get the platform infos received from the peer.
  - clearPlatformInfos
```
public void clearPlatformInfos()
```
    Clear the list of platform infos.
  - getHost
```
public java.lang.String getHost()
```
    Get the host name of the peer server.
  - 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.
  - getDebugText
```
public java.lang.String getDebugText()
```
    Get the debug text.
  - addDebugText
```
public void addDebugText(int level,
                         java.lang.String msg)
```
    Add a debug message.
  - checkPlatform
```
public boolean checkPlatform(java.lang.String id)
```
    Check if a platform is connected to this peer.
  - run
```
public void run()
```
    Execute the handler.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - setPeerState
```
public void setPeerState(java.lang.String peerid,
                         int peerstate)
```
    Set the peer state received from remote. Starts db synchronization, if necessary.
  - shutdown
```
public void shutdown()
```
    Shutdown the handler.
  - peerOnline
```
protected void peerOnline()
```
    Called when the peer becomes online.
  - peerOffline
```
protected void peerOffline()
```
    Called when a peer becomes offline.

Class PeerHandler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DELAY_ONLINE

DELAY_OFFLINE

handler

url

initial

connected

infos

sent

debugtext

peerid

peerstate

shutdown

Constructor Detail

PeerHandler

Method Detail

getUrl

setSent

setConnected

isConnected

isSent

isInitial

updatePlatformInfo

getPlatformInfos

clearPlatformInfos

getHost

getLocation

getCountryCode

getPosition

getDebugText

addDebugText

checkPlatform

run

setPeerState

shutdown

peerOnline

peerOffline