SOCIS2013BundleProtocolProject - Revision history

Dizhizhou at 20:11, 8 December 2013

2013-12-08T20:11:49Z

← Older revision		Revision as of 20:11, 8 December 2013
Line 35:		Line 35:
	# BpPayloadHeader, which implements the bundle payload header in RFC 5050.		# BpPayloadHeader, which implements the bundle payload header in RFC 5050.

	= ~~External bundle~~ protocol APIs =		= Bundle protocol APIs =
	~~External bundle~~ protocol APIs are called by applications.		Bundle protocol APIs are called by applications.

	== Open () ==		== Open () ==
Line 65:		Line 65:

	An example script in src/bundle-protocol/examples is created to show the usage of these APIs. In this section, we show a sample code for registering an application in a bundle node to send bundles.		An example script in src/bundle-protocol/examples is created to show the usage of these APIs. In this section, we show a sample code for registering an application in a bundle node to send bundles.

	~~Ptr<BundleProtocol> sender = CreateObject<BundleProtocol>~~ (); // ~~create a bundle protocol~~		BpEndpointId eidSender ("dtn", "node0"); // build an endpoint id
	~~sender->Open~~ (~~nodes.Get (0)~~); // ~~install this bundle protocol in~~ a ~~node and install cla into this~~ bundle protocol		BundleProtocolHelper bpSender (eidSender); // create a bundle protocol helper
	~~BpEndpointId src = sender->BuildBpEndpointId~~ (~~"dtn","node0"~~); // ~~get an endpoint id: dtn:node0~~		bpSender.SetRoutingProtocol (route); // set the bundle routing protocol
	~~struct registerInfo~~ info; // ~~create~~ registration information		bpSender.SetRegisterInfo (info); // set the registration information
	~~info~~.~~lifetime = 10;~~		BundleProtocolContainer senders = bpSender.Install (nodes.Get (0)); // the bundle protocol helper calls
	~~info~~.~~state = false;~~		// following BP APIs: Open (),
	~~sender->Register~~ (~~src, info~~); // ~~register this endpoint id to~~ the bundle protocol		// SetBpEndpointId (), Register (), Bind ();
	~~sender->Bind~~ (~~src~~)~~; // set the registration of endpoint id src to active state.~~		Ptr<BundleProtocol> sender = senders.Get (0);
	// ~~So far~~, ~~the~~ sender ~~can receive bundles from other nodes~~.
	~~sender->SetRoutingProtocol~~ (~~routing~~); ~~// set the routing protocol for this bundle node~~
	sender->Send (packet, src, dst); // send the packet from endpoint id src to endpoint id dst.		sender->Send (packet, src, dst); // send the packet from endpoint id src to endpoint id dst.
	// The src and dst will be transferred into internet socket address		// The src and dst will be transferred into internet socket address

Dizhizhou: /* Bundle protocol APIs */

2013-12-08T20:06:53Z

Bundle protocol APIs

← Older revision		Revision as of 20:06, 8 December 2013
Line 35:		Line 35:
	# BpPayloadHeader, which implements the bundle payload header in RFC 5050.		# BpPayloadHeader, which implements the bundle payload header in RFC 5050.

	= ~~Bundle~~ protocol APIs =		= External bundle protocol APIs =
	~~In this section, we introduce BP~~ APIs ~~supported~~ by ~~BP in NS-3~~.		External bundle protocol APIs are called by applications.

	== Open () ==		== Open () ==
Line 51:		Line 51:

	== Send () ==		== Send () ==
	~~Send~~ a ~~bundle~~ from the source endpoint id to the destination endpoint id. The bundle will be stored in the persistent bundle storage in BundleProtocol first. ~~When the first bundle is sent by the source endpoint id,~~ the BpClaProtocol establishes the transport layer connection with peer bundle node. Once the transport layer connection is available, the BpClaProtocol will retrieve the bundle in a FIFO order from the storage ~~and then send it~~.		This method is called by applications to send a application data unit (ADU) from the source endpoint id to the destination endpoint id. If the ADU size is larger than the bundle size, ADU is divided into several bundles while each bundle includes a primary bundle header and a bundle payload header. The bundle will be stored in the persistent bundle storage in BundleProtocol first. Then the BpClaProtocol establishes the transport layer connection with peer bundle node. Once the transport layer connection is available, the BpClaProtocol will retrieve and send the bundle by a FIFO order from the storage.

	== Receive () ==		== Receive () ==
	~~Applications~~ can use this API to get bundles stored from storage in a FIFO order.		Application can use this API to get bundles stored from storage in a FIFO order. The bundle headers are removed before forwarding bundles to the application.

	== BuildBpEndpointId () ==		== BuildBpEndpointId () ==
	Build an endpoint id ~~for a registration~~. In BP of NS-3, each registration has a unique endpoint id. a BundleProtocol calss can be served for multiple registrations in a bundle node.		Build an endpoint id based on scheme and ssp strings. In BP of NS-3, each registration has a unique endpoint id. a BundleProtocol calss can be served for multiple registrations in a bundle node.

			== SetBpEndpointId () ==
			Users build an endpoint id and set the endpoint id to the bundle protocol.

	=Usage=		=Usage=

Dizhizhou: /* Protocol structure */

2013-12-08T19:53:44Z

Protocol structure

← Older revision		Revision as of 19:53, 8 December 2013
Line 28:		Line 28:
	# BpRoutingProtocol class is a pure abstract class, which defines the APIs of bundle routing protocol. In the existing implementation, only BpStaticRoutingProtocol is implemented, which uses a static map between local endpoint id and internet socket address.		# BpRoutingProtocol class is a pure abstract class, which defines the APIs of bundle routing protocol. In the existing implementation, only BpStaticRoutingProtocol is implemented, which uses a static map between local endpoint id and internet socket address.

	In addition to above three core classes, bundle protocol model also ~~include~~ classes:		In addition to above three core classes, the NS-3 bundle protocol model also includes classes:

	# BundleProtocolHelper and BundleProtocolContainer classes, which are implemented to facilitate users to create a bundle node. Then endpoint id data structure is supported at a BpEndpointId class;		# BundleProtocolHelper and BundleProtocolContainer classes, which are implemented to facilitate users to create a bundle node. Then endpoint id data structure is supported at a BpEndpointId class;

Dizhizhou: /* Protocol structure */

2013-12-08T19:53:22Z

Protocol structure

← Older revision		Revision as of 19:53, 8 December 2013
Line 24:		Line 24:
	The rectangle area represents the main classes of BP in NS-3.		The rectangle area represents the main classes of BP in NS-3.

	# BundleProtocol class implements several BP APIs to applications, such as Register (), Open (), Bind () and so on. Applications can use these APIs to transmit bundles between bundle nodes. The other functions implemented in the BundleProtocol class include bundle fragmentation and aggregation, bundle storage and registration storage.		# BundleProtocol class implements several BP APIs to applications, such as Register (), Open (), Bind () and so on. Applications can use these APIs to transmit bundles between bundle nodes. The name and functions of these APIs are referenced from a Linux bundle protocol implementation -- [http://www.dtnrg.org/wiki/Code DTN2]. The other functions implemented in the BundleProtocol class include bundle fragmentation and aggregation, bundle storage and registration storage;
	# BpClaProtocol class is a pure abstract class for convergence layer adaptor (CLA). For each transport layer protocol, a new CLA class needs to be inherited from BpClaProtocol. In the existing implementation, only BpTcpClaProtocol is implemented. It uses TCP socket in the transport layer to transmit bundles.		# BpClaProtocol class is a pure abstract class for convergence layer adaptor (CLA). For each transport layer protocol, a new CLA class needs to be inherited from BpClaProtocol. In the existing implementation, only BpTcpClaProtocol is implemented. It uses TCP socket in the transport layer to transmit bundles;
	# BpRoutingProtocol class is a pure abstract class, which defines the APIs of bundle routing protocol. In the existing implementation, only BpStaticRoutingProtocol is implemented, which uses a static map between local endpoint id and internet socket address.		# BpRoutingProtocol class is a pure abstract class, which defines the APIs of bundle routing protocol. In the existing implementation, only BpStaticRoutingProtocol is implemented, which uses a static map between local endpoint id and internet socket address.

	In addition to above three core classes, a BundleProtocolHelper and a BundleProtocolContainer classes are implemented to facilitate users to create a bundle node.		In addition to above three core classes, bundle protocol model also include classes:

			# BundleProtocolHelper and BundleProtocolContainer classes, which are implemented to facilitate users to create a bundle node. Then endpoint id data structure is supported at a BpEndpointId class;
			# BpEndpointId, which implements the endpoint id data structure for bundle protocol;
			# BpHeader, which implements the primary bundle header in RFC 5050.
			# BpPayloadHeader, which implements the bundle payload header in RFC 5050.

	= Bundle protocol APIs =		= Bundle protocol APIs =

Dizhizhou: /* Protocol structure */

2013-12-08T19:46:12Z

Protocol structure

← Older revision		Revision as of 19:46, 8 December 2013
Line 24:		Line 24:
	The rectangle area represents the main classes of BP in NS-3.		The rectangle area represents the main classes of BP in NS-3.

	# BundleProtocol class implements several BP APIs to applications, such as Register (), Open (), Bind () and so on. Applications can use these APIs to transmit bundles between bundle nodes.		# BundleProtocol class implements several BP APIs to applications, such as Register (), Open (), Bind () and so on. Applications can use these APIs to transmit bundles between bundle nodes. The other functions implemented in the BundleProtocol class include bundle fragmentation and aggregation, bundle storage and registration storage.
	# BpClaProtocol class is a pure abstract class for convergence layer adaptor (CLA). For each transport layer protocol, a new CLA class needs to be inherited from BpClaProtocol. In the existing ~~version~~, only BpTcpClaProtocol is implemented. It uses TCP socket in the transport layer to transmit bundles.		# BpClaProtocol class is a pure abstract class for convergence layer adaptor (CLA). For each transport layer protocol, a new CLA class needs to be inherited from BpClaProtocol. In the existing implementation, only BpTcpClaProtocol is implemented. It uses TCP socket in the transport layer to transmit bundles.
	# BpRoutingProtocol class is a pure abstract class, which defines the APIs of bundle routing protocol. In the existing ~~version~~, only BpStaticRoutingProtocol is implemented, which uses a static map between local endpoint id and internet socket address.		# BpRoutingProtocol class is a pure abstract class, which defines the APIs of bundle routing protocol. In the existing implementation, only BpStaticRoutingProtocol is implemented, which uses a static map between local endpoint id and internet socket address.

	In ~~the existing implementation~~, ~~multiple bundles can be transmitted between two~~ bundle ~~nodes, which are connected directly by p2p link~~.		In addition to above three core classes, a BundleProtocolHelper and a BundleProtocolContainer classes are implemented to facilitate users to create a bundle node.

	= Bundle protocol APIs =		= Bundle protocol APIs =

Dizhizhou at 00:35, 19 November 2013

2013-11-19T00:35:51Z

← Older revision		Revision as of 00:35, 19 November 2013
Line 76:		Line 76:
	* S1: functions to make sure the bundle can be sent from sender to receiver, node structure, send/receive/forward, static routing, naming syntax.		* S1: functions to make sure the bundle can be sent from sender to receiver, node structure, send/receive/forward, static routing, naming syntax.
	* S2: control functions for custody transfer, custody signal in AA.		* S2: control functions for custody transfer, custody signal in AA.
	* S3: error control signals: bundle status report.

	~~= Milestones =~~
	~~This project aims to achieve following milestones:~~
	~~# Send and receive multiple bundles between two directly connected bundle nodes.~~
	~~# Custody support~~

	= Plan =		= Plan =

Dizhizhou: /* Milestones */

2013-11-19T00:35:12Z

Milestones

← Older revision		Revision as of 00:35, 19 November 2013
Line 80:		Line 80:
	= Milestones =		= Milestones =
	This project aims to achieve following milestones:		This project aims to achieve following milestones:
	~~# Send and receive a single bundle between two directly connected bundle nodes.~~
	# Send and receive multiple bundles between two directly connected bundle nodes.		# Send and receive multiple bundles between two directly connected bundle nodes.
	# Custody support		# Custody support

Dizhizhou: /* Usage */

2013-11-19T00:34:46Z

Usage

← Older revision		Revision as of 00:34, 19 November 2013
Line 65:		Line 65:
	info.state = false;		info.state = false;
	sender->Register (src, info); // register this endpoint id to the bundle protocol		sender->Register (src, info); // register this endpoint id to the bundle protocol
	sender->Bind (src); // set the registration of endpoint id src to active state. So far, the sender can receive bundles from other nodes.		sender->Bind (src); // set the registration of endpoint id src to active state.
			// So far, the sender can receive bundles from other nodes.
	sender->SetRoutingProtocol (routing); // set the routing protocol for this bundle node		sender->SetRoutingProtocol (routing); // set the routing protocol for this bundle node
	sender->Send (packet, src, dst); // send the packet from endpoint id src to endpoint id dst. The src and dst will be transferred into internet socket address based on bundle routing protocol.		sender->Send (packet, src, dst); // send the packet from endpoint id src to endpoint id dst.
			// The src and dst will be transferred into internet socket address
			// based on bundle routing protocol.

	= Approach =		= Approach =

Dizhizhou: /* Usage */

2013-11-19T00:33:39Z

Usage

← Older revision		Revision as of 00:33, 19 November 2013
Line 55:		Line 55:

	=Usage=		=Usage=

			An example script in src/bundle-protocol/examples is created to show the usage of these APIs. In this section, we show a sample code for registering an application in a bundle node to send bundles.

			Ptr<BundleProtocol> sender = CreateObject<BundleProtocol> (); // create a bundle protocol
			sender->Open (nodes.Get (0)); // install this bundle protocol in a node and install cla into this bundle protocol
			BpEndpointId src = sender->BuildBpEndpointId ("dtn","node0"); // get an endpoint id: dtn:node0
			struct registerInfo info; // create registration information
			info.lifetime = 10;
			info.state = false;
			sender->Register (src, info); // register this endpoint id to the bundle protocol
			sender->Bind (src); // set the registration of endpoint id src to active state. So far, the sender can receive bundles from other nodes.
			sender->SetRoutingProtocol (routing); // set the routing protocol for this bundle node
			sender->Send (packet, src, dst); // send the packet from endpoint id src to endpoint id dst. The src and dst will be transferred into internet socket address based on bundle routing protocol.

	= Approach =		= Approach =

Dizhizhou at 00:24, 19 November 2013

2013-11-19T00:24:57Z

← Older revision		Revision as of 00:24, 19 November 2013
Line 53:		Line 53:
	== BuildBpEndpointId () ==		== BuildBpEndpointId () ==
	Build an endpoint id for a registration. In BP of NS-3, each registration has a unique endpoint id. a BundleProtocol calss can be served for multiple registrations in a bundle node.		Build an endpoint id for a registration. In BP of NS-3, each registration has a unique endpoint id. a BundleProtocol calss can be served for multiple registrations in a bundle node.

			=Usage=

	= Approach =		= Approach =