de.taimos.gpsd4java.backend

Class GPSdEndpoint

java.lang.Object

de.taimos.gpsd4java.backend.GPSdEndpoint

public class GPSdEndpoint
extends Object

GPSd client endpoint

Author:

thoeger

Constructor Summary

Constructors

Constructor and Description
GPSdEndpoint(String server, int port, AbstractResultParser resultParser) Instantiate this class to connect to a GPSd server
GPSdEndpoint(String server, int port, AbstractResultParser resultParser, boolean daemon) Instantiate this class to connect to a GPSd server

Method Summary

Modifier and Type	Method and Description
void	addListener(IObjectListener listener)
long	getRetryInterval() Returns the retry interval for reconnecting to GPSD if the socket closes.
void	kickDevice(String path) Attempt to kick a failed device back into life on gpsd server.
PollObject	poll() Poll GPSd for Message
void	removeListener(IObjectListener listener)
void	setRetryInterval(long millis) Set a retry interval for reconnecting to GPSD if the socket closes.
void	start() start the endpoint
void	stop() Stops the endpoint.
VersionObject	version() Poll GPSd version
WatchObject	watch(boolean enable, boolean dumpData) send WATCH command
WatchObject	watch(boolean enable, boolean dumpData, String device) send WATCH command

Methods inherited from class java.lang.Object

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

Constructor Detail

GPSdEndpoint

public GPSdEndpoint(String server,
                    int port,
                    AbstractResultParser resultParser,
                    boolean daemon)
             throws UnknownHostException,
                    IOException

Instantiate this class to connect to a GPSd server

Parameters:

server - the server name or IP

port - the server port

resultParser - the result parser

daemon - whether to start the underlying socket thread as a daemon, as defined in Thread.setDaemon(boolean)

Throws:

UnknownHostException

IOException

GPSdEndpoint

public GPSdEndpoint(String server,
                    int port,
                    AbstractResultParser resultParser)
             throws UnknownHostException,
                    IOException

Instantiate this class to connect to a GPSd server

Parameters:

server - the server name or IP

port - the server port

resultParser - the result parser

Throws:

UnknownHostException

IOException

Method Detail

start

public void start()

start the endpoint

stop

public void stop()

Stops the endpoint.

watch

public WatchObject watch(boolean enable,
                         boolean dumpData)
                  throws IOException,
                         org.json.JSONException

send WATCH command

Parameters:

enable - enable/disable watch mode

dumpData - enable/disable dumping of data

Returns:

WatchObject

Throws:

IOException - on IO error in socket

org.json.JSONException

watch

public WatchObject watch(boolean enable,
                         boolean dumpData,
                         String device)
                  throws IOException,
                         org.json.JSONException

send WATCH command

Parameters:

enable - enable/disable watch mode

dumpData - enable/disable dumping of data

device - If present, enable watching only of the specified device rather than all devices

Returns:

WatchObject

Throws:

IOException - on IO error in socket

org.json.JSONException

poll

public PollObject poll()
                throws IOException

Poll GPSd for Message

Returns:

PollObject

Throws:

IOException - on IO error in socket

version

public VersionObject version()
                      throws IOException

Poll GPSd version

Returns:

VersionObject

Throws:

IOException - on IO error in socket

addListener

public void addListener(IObjectListener listener)

Parameters:

listener - the listener to add

removeListener

public void removeListener(IObjectListener listener)

Parameters:

listener - the listener to remove

kickDevice

public void kickDevice(String path)
                throws IOException,
                       org.json.JSONException

Attempt to kick a failed device back into life on gpsd server.

see: https://lists.gnu.org/archive/html/gpsd-dev/2015-06/msg00001.html

Parameters:

path - Path of device known to gpsd

Throws:

IOException

org.json.JSONException

setRetryInterval

public void setRetryInterval(long millis)

Set a retry interval for reconnecting to GPSD if the socket closes. Default value is 1000ms.

Parameters:

millis - how long to wait between each reconnection attempts.

getRetryInterval

public long getRetryInterval()

Returns the retry interval for reconnecting to GPSD if the socket closes. Default value is 1000ms.

Returns:

retry interval