DigitalSpaces::DIDataTransfer1 Struct Reference
[Interfaces]

#include <Interfaces.h>

Inherits DigitalSpaces::DIObjectBase.


Detailed Description

Interface for transferring data between systems over a network.

The existing implementation (DataTransfer_SILC) is configured by use of DIAcceptConfiguration1. It uses the public SILC network (see http://silcnet.org/ ). It creates a channel on the public network (based on the path to the .space file being ran) and uses the channel as a method to distribute the data sent into the SendChunk function. When a message is received from another client via the channel, the implementation checks if any DIAcceptConfiguration1 implementations have been registered with RegisterAsListening with the appropriate ID. The implementation runs in a single thread in the normal PerformHeartbeat system, so any object registered with RegisterAsListening does not have to worry about concurrency issues.

Todo:
Look at adding a "channel" or "group" id to these functions, to allow selective subgroubs beyond entire space

Public Member Functions

void SendChunk (DIXMLNode1 *pChunk)
 Sends a "chunck" format XML fragment.
void RegisterAsListening (DIAcceptConfiguration1 *listener, const DUID *chunkID)
 Register an object to receive any received XML "chunk" fragments that match the format specified by the chunkID.

Member Function Documentation

void DigitalSpaces::DIDataTransfer1::SendChunk ( DIXMLNode1 pChunk  ) 

Sends a "chunck" format XML fragment.

The chunk format specifies that the root note should be <chunk id="{FORMAT-ID}"> , with the format ID being the configuration DUID it is formatted as.

void DigitalSpaces::DIDataTransfer1::RegisterAsListening ( DIAcceptConfiguration1 listener,
const DUID chunkID 
)

Register an object to receive any received XML "chunk" fragments that match the format specified by the chunkID.


The documentation for this struct was generated from the following file:

Generated on Fri Aug 22 18:12:10 2008 for Digital Spaces by  doxygen 1.5.6