lac.cnet.gateway.components

Class Gateway

java.lang.Object

lac.cnet.gateway.components.Gateway

All Implemented Interfaces:

ExtendedMessageListener, NodeConnectionListener, NodeConnectionServerListener, SddlNetworkListener

public class Gateway
extends java.lang.Object
implements NodeConnectionServerListener, NodeConnectionListener, SddlNetworkListener, ExtendedMessageListener

The Gateway (GW) defines a unique Point of Attachment (PoA), for connection with the mobile nodes. The Gateway is thus responsible for managing a separate RUDP connection with each of these nodes, forwarding any application-specific message or context information into the core network, and in the opposite direction, converting DDS messages to RUDP messages and delivering them reliably to the corresponding node/s. Moreover, it keeps track of the connectivity status of each attached mobile node, as well as the application-specific groups to which each node belongs. The association of nodes to groups is done by the GroupDefiners, which are application specific processing nodes in the core network.

Author:

Rafael Oliveira Vasconcelos

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT Default incoming port to receive data from nodes

Constructor Summary

Constructors

Constructor and Description
Gateway(int serverPort, java.lang.String externalRUDPIp, java.util.UUID gatewayId)
Gateway(int serverPort, java.lang.String externalRUDPIp, java.util.UUID gatewayId, boolean useTotalOrderGroupcast) Initialize the Gateway from MR-UDP Server Port, External MR-UDP Port, Gateway´s ID

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the Gateway
void	connected(NodeConnection remoteCon) Used only on client side Called when the connection is stabilished.
void	disconnected(NodeConnection remoteCon) Called when the connection is lost.
void	internalException(NodeConnection nodeConnection, java.lang.Exception exception) Called when a internal exception occurs in the RemoteConnection implementation.
void	newMessageReceived(NodeConnection remoteCon, ExtendedMessage message) Called when the Gateway sends a object.
void	newMessageReceived(NodeConnection nodeConnection, Message message) Called when the Gateway sends a object.
void	newNodeConnection(NodeConnection nodeCon) Called when a new connection is made.
void	newPointOfAttachmentListReceived(NodeConnection remoteCon, PointsOfAttachment poaList) Called when the SDDL core sends a new points of attachment list.
void	pingReceived(NodeConnection remoteCon, Ping ping) Called when the RemoteConnection receives a ping.
void	receiveGroupAdvertisementTopic(GroupAdvertisement groupAdvertisement) Receives a GroupAdvertisementTopic from DDS Domain and updates the node´s group membership
void	receiveGroupMessageTopic(GroupMessage groupMessage) Receives a GroupMessage Topic from DDS Domain and forward it to node(s)
void	receiveLoadReportTopic(LoadReport loadReport) Receives a LoadReport Topic from DDS Domain
void	receivePingTopic(Ping ping) Receives a Ping Topic from DDS Domain and may forward it to node(s)
void	receivePrivateMessageTopic(PrivateMessage privateMessage) Receives a PrivateMessage Topic from DDS Domain and forward it to node(s)
void	receiveUnsentMessageTopic(UnsentMessage unsentMessage) Receives a UnsentMessage Topic from DDS Domain and forward it, if applicable, to node When Gateway receives a UnsentMessage from DDS Domain the GW checks if node is connected with it (the GW) and (if connected) forward the unsent messages to the node
void	reconnected(NodeConnection remoteCon, java.net.SocketAddress endPoint, boolean wasHandover, boolean wasMandatory) Method called to inform that the connection was broken but made again.
void	sendLoadReportTopic(LoadReport loadReport) Sends a Load Report through the DDS domain
void	sendUnsentMessage(java.util.UUID nodeId, byte[] unsentMessage) Sends (forward) the unsent messages to the node
void	startingHandover(NodeConnection remoteCon, java.net.SocketAddress endPoint, boolean wasMandatory) Called when the remote connection will handover to a new Gateway.
void	unsentMessages(NodeConnection remoteCon, java.util.List<Message> unsentMessages) Called when connection drops and there is unacked sent messages.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Default incoming port to receive data from nodes

See Also:

Constant Field Values

Constructor Detail

Gateway

public Gateway(int serverPort,
       java.lang.String externalRUDPIp,
       java.util.UUID gatewayId,
       boolean useTotalOrderGroupcast)
        throws java.io.IOException

Initialize the Gateway from MR-UDP Server Port, External MR-UDP Port, Gateway´s ID

Parameters:

serverPort - Incoming port to receive node data through MR-UDP

externalRUDPIp - Gateway´s IP that nodes are able to connect via MR-UDP

gatewayId - Gateway´s ID

useTotalOrderGroupcast - Informs if GW should use the total order groupcast

Throws:

java.io.IOException - If an I/O error occurs when opening the underlying UDP socket.

Gateway

public Gateway(int serverPort,
       java.lang.String externalRUDPIp,
       java.util.UUID gatewayId)
        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

internalException

public void internalException(NodeConnection nodeConnection,
                     java.lang.Exception exception)

Description copied from interface: NodeConnectionListener

Called when a internal exception occurs in the RemoteConnection implementation.

Specified by:

internalException in interface NodeConnectionListener

Parameters:

nodeConnection - the RemoteConnection related

exception - the Exception

reconnected

public void reconnected(NodeConnection remoteCon,
               java.net.SocketAddress endPoint,
               boolean wasHandover,
               boolean wasMandatory)

Description copied from interface: NodeConnectionListener

Method called to inform that the connection was broken but made again.

Specified by:

reconnected in interface NodeConnectionListener

Parameters:

remoteCon - the related remote connection

endPoint - the end point connected

wasHandover - if a handover was made, ie. if the current end point is the different than the last

wasMandatory - is it was a mandatory handover

newNodeConnection

public void newNodeConnection(NodeConnection nodeCon)

Called when a new connection is made.

Specified by:

newNodeConnection in interface NodeConnectionServerListener

connected

public void connected(NodeConnection remoteCon)

Used only on client side Called when the connection is stabilished.

Specified by:

connected in interface NodeConnectionListener

Parameters:

remoteCon - the RemoteConnection which the event happened

disconnected

public void disconnected(NodeConnection remoteCon)

Called when the connection is lost.

Specified by:

disconnected in interface NodeConnectionListener

Parameters:

remoteCon - the RemoteConnection which the event happened

newMessageReceived

public void newMessageReceived(NodeConnection nodeConnection,
                      Message message)

Called when the Gateway sends a object.

Specified by:

newMessageReceived in interface NodeConnectionListener

Parameters:

nodeConnection - the RemoteConnection which the event happened

message - the message just received

unsentMessages

public void unsentMessages(NodeConnection remoteCon,
                  java.util.List<Message> unsentMessages)

Called when connection drops and there is unacked sent messages.

Specified by:

unsentMessages in interface NodeConnectionListener

Parameters:

remoteCon - the Remote Connection related with the event

unsentMessages - a list with all unsent messages

receiveGroupAdvertisementTopic

public void receiveGroupAdvertisementTopic(GroupAdvertisement groupAdvertisement)

Receives a GroupAdvertisementTopic from DDS Domain and updates the node´s group membership

Parameters:

groupAdvertisement - The GroupAdvertisement received from DDS

receivePrivateMessageTopic

public void receivePrivateMessageTopic(PrivateMessage privateMessage)

Receives a PrivateMessage Topic from DDS Domain and forward it to node(s)

Parameters:

privateMessage - The message that should be forwarded to node(s)

receiveUnsentMessageTopic

public void receiveUnsentMessageTopic(UnsentMessage unsentMessage)

Receives a UnsentMessage Topic from DDS Domain and forward it, if applicable, to node When Gateway receives a UnsentMessage from DDS Domain the GW checks if node is connected with it (the GW) and (if connected) forward the unsent messages to the node

Parameters:

unsentMessage -

receivePingTopic

public void receivePingTopic(Ping ping)

Receives a Ping Topic from DDS Domain and may forward it to node(s)

Parameters:

ping - The ping received

sendUnsentMessage

public void sendUnsentMessage(java.util.UUID nodeId,
                     byte[] unsentMessage)

Sends (forward) the unsent messages to the node

Parameters:

nodeId - Vehicle´s Id

unsentMessage - A byte[] with all unsent messages

sendLoadReportTopic

public void sendLoadReportTopic(LoadReport loadReport)

Sends a Load Report through the DDS domain

Parameters:

loadReport - The LoadReport to be sent

close

public void close()

Closes the Gateway

pingReceived

public void pingReceived(NodeConnection remoteCon,
                Ping ping)

Called when the RemoteConnection receives a ping.

Specified by:

pingReceived in interface SddlNetworkListener

Parameters:

remoteCon - the related remote connection

ping - the ping object

newPointOfAttachmentListReceived

public void newPointOfAttachmentListReceived(NodeConnection remoteCon,
                                    PointsOfAttachment poaList)

Called when the SDDL core sends a new points of attachment list.

Specified by:

newPointOfAttachmentListReceived in interface SddlNetworkListener

Parameters:

remoteCon - the related remote connection

poaList - the points of attachment list

startingHandover

public void startingHandover(NodeConnection remoteCon,
                    java.net.SocketAddress endPoint,
                    boolean wasMandatory)

Called when the remote connection will handover to a new Gateway.

Specified by:

startingHandover in interface SddlNetworkListener

Parameters:

remoteCon - the related remote connection

endPoint - the new gateway endpoint

wasMandatory - true if it was a mandatory handover.

newMessageReceived

public void newMessageReceived(NodeConnection remoteCon,
                      ExtendedMessage message)

Description copied from interface: ExtendedMessageListener

Called when the Gateway sends a object.

Specified by:

newMessageReceived in interface ExtendedMessageListener

Parameters:

remoteCon - the RemoteConnection which the event happened

message - the message just received

receiveGroupMessageTopic

public void receiveGroupMessageTopic(GroupMessage groupMessage)

Receives a GroupMessage Topic from DDS Domain and forward it to node(s)

Parameters:

groupMessage - The message that should be forwarded to node(s)

receiveLoadReportTopic

public void receiveLoadReportTopic(LoadReport loadReport)

Receives a LoadReport Topic from DDS Domain

Parameters:

loadReport - The LoadReport from another gateway