com.microsoft.azure.gateway.core

Class GatewayModule

java.lang.Object

com.microsoft.azure.gateway.core.GatewayModule

All Implemented Interfaces:

IGatewayModule

public abstract class GatewayModule
extends Object
implements IGatewayModule

The Abstract GatewayModule class to be extended by the module-creator when creating any modules.

Constructor Summary

Constructors

Constructor and Description
GatewayModule(long address, Broker broker, String configuration) Constructs a GatewayModule from the provided address and Broker.

Method Summary

Modifier and Type	Method and Description
void	create(long moduleAddr, Broker broker, String configuration) The create method is called when the native Gateway creates the Module.
abstract void	destroy() The destroy method is called on a GatewayModule before it is about to be "destroyed" and removed from the gateway.
Broker	getBroker()
String	getConfiguration() Gets the JSON configuration string for this GatewayModule
int	publish(Message message) Publishes the Message to the Broker.
void	receive(byte[] serializedMessage) The receive method is called on a GatewayModule whenever it receives a message.
abstract void	receive(Message message)
void	start() The start method is called when the native Gateway has created all modules to notify each module that it is safe to start sending messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayModule

public GatewayModule(long address,
                     Broker broker,
                     String configuration)

Constructs a GatewayModule from the provided address and Broker. A GatewayModule should always call this super constructor before any module-specific constructor code. The address parameter must be passed to the super constructor but can be ignored by the module-implementor when writing a module implementation.

Parameters:

address - The address of the native module pointer.

broker - The Broker to which this module belongs

configuration - The module-specific configuration

Method Detail

receive

public abstract void receive(Message message)

destroy

public abstract void destroy()

Description copied from interface: IGatewayModule

The destroy method is called on a GatewayModule before it is about to be "destroyed" and removed from the gateway. Once a module is removed from the gateway, it may no longer send or receive messages. The destroy() and receive() methods are guaranteed to not be called simultaneously.

Specified by:

destroy in interface IGatewayModule

create

public void create(long moduleAddr,
                   Broker broker,
                   String configuration)

Description copied from interface: IGatewayModule

The create method is called when the native Gateway creates the Module.

Specified by:

create in interface IGatewayModule

Parameters:

moduleAddr - The address of the native module pointer

broker - The Broker to which this module belongs

configuration - The configuration for this module represented as a JSON string

start

public void start()

Description copied from interface: IGatewayModule

The start method is called when the native Gateway has created all modules to notify each module that it is safe to start sending messages. This method is optional, but it is recommended that any long-running processes get started in this method.

Specified by:

start in interface IGatewayModule

receive

public void receive(byte[] serializedMessage)

Description copied from interface: IGatewayModule

The receive method is called on a GatewayModule whenever it receives a message. The destroy() and receive() methods are guaranteed to not be called simultaneously.

Specified by:

receive in interface IGatewayModule

Parameters:

serializedMessage - The serialized message

publish

public int publish(Message message)
            throws IOException

Publishes the Message to the Broker.

Parameters:

message - The Message to be published

Returns:

0 on success, non-zero otherwise. See Message broker documentation.

Throws:

IOException - If the Message cannot be serialized.

getBroker

public final Broker getBroker()

getConfiguration

public final String getConfiguration()

Gets the JSON configuration string for this GatewayModule

Returns:

The JSON configuration for this GatewayModule