Java Mine
ContentsIndexHome
PreviousUpNext
MineServer Members

The following tables list the members exposed by MineServer.

 
Name 
Description 
 
Public Event GatewayMessage;

Fired when a message is received from a gateway.
 
 

  • Fired when an exception is caught allowing the exception to be logged.

public Event LogException; *

  • Fires the LogException event.
*
  • @param ex Exception to be passed.
  • @param location Method name where the exception occurred.
 
 

  • Fired when changes have been made to the gateway object that can be
  • persisted to a permanent data store.

public Event PersistGateway; *

  • Fires PersistGateway event.
*
  • @param gatewayID Numerical identifier of gateway.
 
 

  • Fired when changes have been made to the sensor object that can be
  • persisted to a permanent data store.

public Event PersistSensor; *

  • Fires PersitSensor event.
*
  • @param sensor Sensor that has been modified.
 
 
public Event SensorMessage;

Fired when one or more sensor messages are received.
 
 
public event EventHandler UnknownGateway;

Fired when Mine receives a message from an unregistered gateway.
 
 
public event EventHandler UnknownSensor;

Fired when a gateway declines a join from a sensor.
 
 
Name 
Description 
 
GATEWAY RESPONSE HANDLING 
 
Name 
Description 
 
> 
Properties 
 
>> 
This is >>, a member of class MineServer. 
 
This is addExceptionProcessingHandler, a member of class MineServer. 
 
This is addGatewayDataProcessingHandler, a member of class MineServer. 
 
This is addGatewayResponseHandler, a member of class MineServer. 
 
This is addPersistGatewayHandler, a member of class MineServer. 
 
This is addPersistSensorHandler, a member of class MineServer. 
 
This is addSensorDataProcessingHandler, a member of class MineServer. 
 
This is addUnknownGatewayHandler, a member of class MineServer. 
 
This is addUnknownSensorHandler, a member of class MineServer. 
 
This is assignExternalDeviceStorageHandler, a member of class MineServer. 
 

Clear queue of all commands to be sent to sensor
 
 

Returns a UTC Calendar based on the seconds passed in
 
 

Returns a simpleDateFormat of ("E MMM dd yyyy hh:mm:ss a") date and time will look like -> Fri Jan 01 2010 12:00:00 PM. for display purposes
 
 

Queues sensor specific command to be sent down
 
 

Access to the object instances used by the server. Returns null if gatewayID does not belong to any of the registered gateways.
 
 
class MineServerInternal { Internal Methods 
 

Access to the object instances used by the server. Returns empty if gatewayID is not found.
 
 

Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways.
 
 

Access to the object instances used by the server.
 
 

Returns a UTC Calendar based on the seconds passed in
 
 
This is GetStartUPParameters, a member of class MineServer. 
 

Returns the current version of the API  
 
This is HandleActionControlAck, a member of class MineServer. 
 
This is HandleFindGateway, a member of class MineServer. 
 
This is HandleParentMessage, a member of class MineServer. 
 
This is HandleReadDataAck, a member of class MineServer. 
 
This is HandleWriteDataAck, a member of class MineServer. 
 
This is the overview for the MineServer constructor overload. 
 
This is OnACTLAck, a member of class MineServer. 
 
This is OnBootloaderAck, a member of class MineServer. 
 
This is OnFindGateway, a member of class MineServer. 
 
This is OnNetworkStatus, a member of class MineServer. 
 
This is OnParentMsg, a member of class MineServer. 
 
This is OnProcessData, a member of class MineServer. 
 
This is OnReadDataAck, a member of class MineServer. 
 
This is OnSensorStatus, a member of class MineServer. 
 
This is OnWriteDataAck, a member of class MineServer. 
 
This is ParseIP, a member of class MineServer. 
 
This is ParseMessage, a member of class MineServer. 
 
This is ProcessBytes, a member of class MineServer. 
 

Adds the gateway to the servers list of valid objects
 
 

Adds the sensor to the servers list of valid objects
 
 
This is removeExceptionProcessingHandler, a member of class MineServer. 
 
This is removeExternalDeviceStorageHandler, a member of class MineServer. 
 

Removes the gateway from the servers list of valid objects
 
 
This is removeGatewayDataProcessingHandler, a member of class MineServer. 
 
This is removeGatewayResponseHandler, a member of class MineServer. 
 
This is removePersistGatewayHandler, a member of class MineServer. 
 
This is removePersistSensorHandler, a member of class MineServer. 
 

Removes the sensor from the servers list of valid objects
 
 
This is removeSensorDataProcessingHandler, a member of class MineServer. 
 
This is removeUnknownGatewayHandler, a member of class MineServer. 
 
This is removeUnknownSensorHandler, a member of class MineServer. 
 
This is the overview for the resetEncryptionAck method overload. 
 

gets how many seconds its been since January 1st 2010 to set date times returns the time based off of UTC / 
 
Public Methods 
 

This call starts the socket listeners that the gateways will use to communicate
 
 

This call stops the socket listeners that the gateways will use to communicate
 
 

Returns a UTC Calendar object
 
Copyright (c) 2017. All rights reserved.
What do you think about this topic? Send feedback!