Name 

Description 

 

OnGatewayMessage 

/ Fired when a message is received from a gateway. / public Event GatewayMessage; / / Fires Gateway event. / / Class holding data about the gateway communication. 

 

OnLogException 

/ 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. 

 

OnPersistGateway 

/ 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. 

 

OnPersistSensor 

/ 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. 

 

OnSensorMessages 

/ 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 

 

GatewayResponseHandlers 

GATEWAY RESPONSE HANDLING 

 

Name 

Description 

 

> 

region Properties 

 

addExceptionProcessingHandler 

This is addExceptionProcessingHandler, a member of class MineServer. 

 

addGatewayDataProcessingHandler 

This is addGatewayDataProcessingHandler, a member of class MineServer. 

 

addGatewayResponseHandler 

This is addGatewayResponseHandler, a member of class MineServer. 

 

addPersistGatewayHandler 

This is addPersistGatewayHandler, a member of class MineServer. 

 

addPersistSensorHandler 

This is addPersistSensorHandler, a member of class MineServer. 

 

addSensorDataProcessingHandler 

This is addSensorDataProcessingHandler, a member of class MineServer. 

 

ClearCommandQueue 

Clear queue of all commands to be sent to sensor Numerical identifier of sensor to send command 

 

CurrentUTC 

Returns a UTC Calendar based on the seconds passed in
 

 

DisplayDateAsUTC 

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
 

 

EnqueueCommand 

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 

 

FindGateway 

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 

 

FindGatewayByExternalIdentifier 

region Internal Methods 

 

FindSensor 

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 

 

GetCalendarFromSeconds 

Returns a UTC Calendar based on the seconds passed in
 

 

HandleActionControlAck 

This is HandleActionControlAck, a member of class MineServer. 

 

HandleParentMessage 

This is HandleParentMessage, a member of class MineServer. 

 

HandleReadDataAck 

This is HandleReadDataAck, a member of class MineServer. 

 

HandleWriteDataAck 

This is HandleWriteDataAck, a member of class MineServer. 

 

MineServer 

region Constructors Initializes a new instance of the Server class. Protocol server will accept data from. IP address to bind socket(s) to. Port to bind socket(s) to. 

 

OnACTLAck 

This is OnACTLAck, a member of class MineServer. 

 

OnBootloaderAck 

This is OnBootloaderAck, a member of class MineServer. 

 

OnNetworkStatus 

This is OnNetworkStatus, a member of class MineServer. 

 

OnParentMsg 

This is OnParentMsg, a member of class MineServer. 

 

OnProcessData 

This is OnProcessData, a member of class MineServer. 

 

OnReadDataAck 

This is OnReadDataAck, a member of class MineServer. 

 

OnSensorStatus 

This is OnSensorStatus, a member of class MineServer. 

 

OnWriteDataAck 

This is OnWriteDataAck, a member of class MineServer. 

 

ParseIP 

This is ParseIP, a member of class MineServer. 

 

ProcessBytes 

This is ProcessBytes, a member of class MineServer. 

 

RegisterGateway 

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)  

 

RegisterSensor 

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)  

 

removeExceptionProcessingHandler 

This is removeExceptionProcessingHandler, a member of class MineServer. 

 

RemoveGateway 

Removes the gateway from the servers list of valid objects Numeric identifier of the gateway object. 

 

removeGatewayDataProcessingHandler 

This is removeGatewayDataProcessingHandler, a member of class MineServer. 

 

removeGatewayResponseHandler 

This is removeGatewayResponseHandler, a member of class MineServer. 

 

removePersistGatewayHandler 

This is removePersistGatewayHandler, a member of class MineServer. 

 

removePersistSensorHandler 

This is removePersistSensorHandler, a member of class MineServer. 

 

RemoveSensor 

Removes the sensor from the servers list of valid objects Numeric identifier of the sensor object. 

 

removeSensorDataProcessingHandler 

This is removeSensorDataProcessingHandler, a member of class MineServer. 

 

resetEncryptionAck 

This is the overview for the resetEncryptionAck method overload. 

 

SecondsSinceFirstDate 

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

 

StartServer 

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. 

 

StopServer 

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

 

updateSensorHashMap 

This is updateSensorHashMap, a member of class MineServer. 

 

UpdateTimeZoneToUTC 

Returns a UTC Calendar object