Monnit Mine Java
ContentsIndexHome
PreviousUpNext
MineServer Methods

The methods of the MineServer class are listed here.

 
Name 
Description 
 
/ Fired when a message is received from a gateway. / public Event GatewayMessage; / / Fires Gateway event. / / Class holding data about the gateway communication. 
 
/ Fired when an exception is caught allowing the exception to be logged. / public Event LogException; / / Fires the LogException event. / / Exception to be passed. / 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. / / 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. / / Numerical identifier of sensor. 
 
/ Fired when one or more sensor messages are received. / public Event SensorMessage; / / Fires the SensorMessage event. / / List of sensor data messages. / Numerical identifier of gateway that send the messages. 
 
Name 
Description 
 
> 
region Properties 
 
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. 
 
Clear queue of all commands to be sent to sensor Numerical identifier of sensor to send command 
 

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 Numerical identifier of sensor to send command Frame for command as returned by SensorBaseProfile class Will set the urgent flag so that the command is broadcast when received by the gateway 
 
Access to the object instances used by the server. Returns null if gatewayID does not belong to any of the registered gateways. Numeric identifier of the gateway object. The gateway object stored in memory 
 
region Internal Methods 
 
Access to the object instances used by the server. Returns null if sensorID does not belong to any of the registered gateways. Numeric identifier of the sensor object. The sensor object stored in memory 
 

Returns a UTC Calendar based on the seconds passed in
 
 
This is HandleActionControlAck, 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 OnACTLAck, a member of class MineServer. 
 
This is OnBootloaderAck, 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 ProcessBytes, a member of class MineServer. 
 
Adds the gateway to the servers list of valid objects Gateway object Parameter "gateway" is null There is already a gateway registered with the same gatewayID, or gatewayID property of gateway is not valid (Zero is not a valid gatewayID)  
 
Adds the sensor to the servers list of valid objects Sensor object Parameter "sensor" is null There is already a sensor registered with the same sensorID, or sensorID property of sensor is not valid (Zero is not a valid sensorID)  
 
This is removeExceptionProcessingHandler, a member of class MineServer. 
 
Removes the gateway from the servers list of valid objects Numeric identifier of the gateway object. 
 
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 Numeric identifier of the sensor object. 
 
This is removeSensorDataProcessingHandler, 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 / 
 
region Public Methods This call starts the socket listeners that the gateways will use to communicate thrown if IP/Port is already bound to another socket. 
 
This call stops the socket listeners that the gateways will use to communicate  
 
This is updateSensorHashMap, a member of class MineServer. 
 

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