com.microsoft.azure.gateway.core

Interface IGatewayModule

All Known Implementing Classes:

GatewayModule

public interface IGatewayModule

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.
void	destroy() The destroy method is called on a GatewayModule before it is about to be "destroyed" and removed from the gateway.
void	receive(byte[] source) The receive method is called on a GatewayModule whenever it receives a 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.

Method Detail

create

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

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

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

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. This method is optional, but it is recommended that any long-running processes get started in this method.

receive

void receive(byte[] source)

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.

Parameters:

source - The serialized message

destroy

void destroy()

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.