Monnit Mine Java
ContentsIndexHome
PreviousUpNext
MineServer Methods

The methods of the MineServer class are listed here.

Protected Methods
 
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 sensorID Numerical identifier of sensor.
 
 
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.
 
Public Methods
 
Name 
Description 
 
> 
Properties 
 

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 empty if gatewayID is not found.
 
 

Returns a UTC Calendar based on the seconds passed in
 
 

Returns the current version of the API  
 

Adds the gateway to the servers list of valid objects
 
 

Adds the sensor to the servers list of valid objects
 
 

Removes the gateway from the servers list of valid objects
 
 

Removes the sensor from the servers list of valid objects
 
 
Gateway Commands 
 

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) 2016. All rights reserved.
What do you think about this topic? Send feedback!