org.myrobotlab.service

Class RemoteAdapter

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.RemoteAdapter

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, Gateway, QueueReporter

public class RemoteAdapter
extends Service
implements Gateway

RemoteAdapter - Multi-node / distributed myrobotlab support. A RemoteAdapter allows other instances of MyRobotLab to connect. Services and resources can be shared by 2 or more joined instances. The default communication listener is a UDP server listening on all addresses on port 6767.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.net.URI,Connection>	connections used as a data interface to all the non-serializable network objects - it will report stats and states
java.lang.String	lastProtocolKey
static org.slf4j.Logger	log

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
RemoteAdapter(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(java.lang.String name)
void	connect(java.lang.String uri)
java.util.HashMap<java.net.URI,Connection>	getClients()
java.util.List<Connection>	getConnections(java.net.URI clientKey)
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getPrefix(java.net.URI protocolKey)
java.lang.Integer	getTcpPort()
java.lang.Integer	getUdpPort()
boolean	isListening()
boolean	isReady()
boolean	isScanning()
static void	main(java.lang.String[] args)
Connection	onHeartbeat(Connection data)
Connection	onNewConnection(Connection conn)
java.lang.String	publishConnect()
Connection	publishConnect(Connection conn)
java.lang.String	publishDisconnect()
Status	publishError()
void	scan()
void	sendRemote(java.lang.String uri, Message msg)
void	sendRemote(java.net.URI uri, Message msg) TODO - support
void	sendRemoteTCP(java.net.URI uri, Message msg)
void	sendRemoteUdp(java.net.URI uri, Message msg)
java.lang.String	setDefaultPrefix(java.lang.String prefix)
void	setPrefix(java.lang.String source, java.lang.String prefix)
void	setTcpPort(java.lang.Integer tcpPort)
void	setUdpPort(java.lang.Integer udpPort)
void	startListening()
void	startListening(int port)
void	startService()
void	stopListening()
void	stopScanning()
void	stopService() Stops the service.
void	websocket(java.lang.String url)

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, stopHeartbeat, stopMsgRecording, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final org.slf4j.Logger log

lastProtocolKey

public java.lang.String lastProtocolKey

connections

public java.util.HashMap<java.net.URI,Connection> connections

used as a data interface to all the non-serializable network objects - it will report stats and states

Constructor Detail

RemoteAdapter

public RemoteAdapter(java.lang.String n)

Method Detail

addConnectionListener

public void addConnectionListener(java.lang.String name)

Specified by:

addConnectionListener in interface Gateway

connect

public void connect(java.lang.String uri)
             throws java.net.URISyntaxException

Specified by:

connect in interface Gateway

Throws:

java.net.URISyntaxException

getClients

public java.util.HashMap<java.net.URI,Connection> getClients()

Specified by:

getClients in interface Gateway

getConnections

public java.util.List<Connection> getConnections(java.net.URI clientKey)

Specified by:

getConnections in interface Gateway

getPrefix

public java.lang.String getPrefix(java.net.URI protocolKey)

Specified by:

getPrefix in interface Gateway

getTcpPort

public java.lang.Integer getTcpPort()

getUdpPort

public java.lang.Integer getUdpPort()

isListening

public boolean isListening()

isReady

public boolean isReady()

Overrides:

isReady in class Service

isScanning

public boolean isScanning()

onHeartbeat

public Connection onHeartbeat(Connection data)

onNewConnection

public Connection onNewConnection(Connection conn)

publishConnect

public Connection publishConnect(Connection conn)

Specified by:

publishConnect in interface Gateway

scan

public void scan()

sendRemote

public void sendRemote(java.lang.String uri,
                       Message msg)
                throws java.net.URISyntaxException

Specified by:

sendRemote in interface Gateway

Throws:

java.net.URISyntaxException

sendRemote

public void sendRemote(java.net.URI uri,
                       Message msg)

TODO - support

 SCHEMES
        tcp tcps
        upd dtls 
        ws  wss 
 
 SERIALIZATIONS
        JSON
        binary - native
        Protobuff
 

Specified by:

sendRemote in interface Gateway

sendRemoteTCP

public void sendRemoteTCP(java.net.URI uri,
                          Message msg)

sendRemoteUdp

public void sendRemoteUdp(java.net.URI uri,
                          Message msg)

setDefaultPrefix

public java.lang.String setDefaultPrefix(java.lang.String prefix)

setPrefix

public void setPrefix(java.lang.String source,
                      java.lang.String prefix)

setTcpPort

public void setTcpPort(java.lang.Integer tcpPort)

setUdpPort

public void setUdpPort(java.lang.Integer udpPort)

startListening

public void startListening()

startListening

public void startListening(int port)

stopListening

public void stopListening()

stopScanning

public void stopScanning()

stopService

public void stopService()

Description copied from class: Service

Stops the service. Stops threads.

Specified by:

stopService in interface ServiceInterface

Overrides:

stopService in class Service

startService

public void startService()

Specified by:

startService in interface ServiceInterface

Overrides:

startService in class Service

websocket

public void websocket(java.lang.String url)
               throws java.io.IOException

Throws:

java.io.IOException

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

main

public static void main(java.lang.String[] args)

publishConnect

public java.lang.String publishConnect()

Specified by:

publishConnect in interface Gateway

publishDisconnect

public java.lang.String publishDisconnect()

Specified by:

publishDisconnect in interface Gateway

publishError

public Status publishError()

Specified by:

publishError in interface Gateway