Difference between revisions of "ECF/API Docs"

From Eclipsepedia

< ECF
Jump to: navigation, search
(File Transfer API)
Line 5: Line 5:
 
Each API has a link to information about the API bundle(s), and detailed information about that bundle, including required bundles/packages, exported bundles, links to javadocs for exported packages, extension points defined/exposed, OSGi Services exposed, and links to source (downloading and browsing).
 
Each API has a link to information about the API bundle(s), and detailed information about that bundle, including required bundles/packages, exported bundles, links to javadocs for exported packages, extension points defined/exposed, OSGi Services exposed, and links to source (downloading and browsing).
  
==ECF Core==
+
=ECF Core=
  
 
The ECF Core API provides support for all other ECF APIs.  This includes identity (ID) services, ECF distributed container (IContainer) interface definition and instance creation.
 
The ECF Core API provides support for all other ECF APIs.  This includes identity (ID) services, ECF distributed container (IContainer) interface definition and instance creation.
Line 25: Line 25:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests/?root=Technology_Project org.eclipse.ecf.tests]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests/?root=Technology_Project org.eclipse.ecf.tests]
  
==Datashare API==
+
=Datashare API=
  
 
The datashare API provides support for asynchronous messaging channels.  Arbitrary data may be reliably sent to publish-and-subscribe channels.
 
The datashare API provides support for asynchronous messaging channels.  Arbitrary data may be reliably sent to publish-and-subscribe channels.
Line 43: Line 43:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.datashare/?root=Technology_Project org.eclipse.ecf.tests.datashare]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.datashare/?root=Technology_Project org.eclipse.ecf.tests.datashare]
  
==Discovery API==
+
=Discovery API=
  
 
The discovery API provides a protocol independent API for discovering remote services.
 
The discovery API provides a protocol independent API for discovering remote services.
Line 63: Line 63:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.discovery/?root=Technology_Project org.eclipse.ecf.tests.discovery]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.discovery/?root=Technology_Project org.eclipse.ecf.tests.discovery]
  
==File Transfer API==
+
=File Transfer API=
  
 
The filetransfer API provides support for both retrieving remote files, and initiating the sending of peer-to-peer file transfer.
 
The filetransfer API provides support for both retrieving remote files, and initiating the sending of peer-to-peer file transfer.
Line 85: Line 85:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.filetransfer/?root=Technology_Project org.eclipse.ecf.tests.filetransfer]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.filetransfer/?root=Technology_Project org.eclipse.ecf.tests.filetransfer]
  
==Presence API==
+
=Presence API=
  
 
The presence API provides a protocol independent API for instant messaging, basic presence/buddy lists/rosters display and management, and multi-user chat rooms.
 
The presence API provides a protocol independent API for instant messaging, basic presence/buddy lists/rosters display and management, and multi-user chat rooms.
Line 105: Line 105:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.presence/?root=Technology_Project org.eclipse.ecf.tests.presence]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.presence/?root=Technology_Project org.eclipse.ecf.tests.presence]
  
==Remote Services API==
+
=Remote Services API=
  
 
The remote services API provides a protocol independent API for accessing remote services on peer OSGi containers.  The remote services may be accessed via proxy, synchronous (call/return) invocation, or asynchronous (call and listen) invocation.
 
The remote services API provides a protocol independent API for accessing remote services on peer OSGi containers.  The remote services may be accessed via proxy, synchronous (call/return) invocation, or asynchronous (call and listen) invocation.
Line 125: Line 125:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.remoteservice/?root=Technology_Project org.eclipse.ecf.tests.remoteservice]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.remoteservice/?root=Technology_Project org.eclipse.ecf.tests.remoteservice]
  
==Shared Object API==
+
=Shared Object API=
  
 
The shared object API provides a protocol independent API for replicating Java objects in a distributed group.
 
The shared object API provides a protocol independent API for replicating Java objects in a distributed group.
Line 145: Line 145:
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.sharedobject/?root=Technology_Project org.eclipse.ecf.tests.sharedobject]
 
[http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.ecf/tests/org.eclipse.ecf.tests.sharedobject/?root=Technology_Project org.eclipse.ecf.tests.sharedobject]
  
==Telephony API==
+
=Telephony API=
  
 
The telephony API supports the initiation/receiving and management of VOIP phone calls.
 
The telephony API supports the initiation/receiving and management of VOIP phone calls.
  
 
TBD.
 
TBD.

Revision as of 18:44, 8 May 2007

Contents

ECF API Documentation

Below are bundle-level documentation for each of the main ECF 1.0.0 APIs: ECF Core, Datashare API, Discovery API, File Transfer API, Presence API, Remote Services API, Shared Object API, and Telephony API.

Each API has a link to information about the API bundle(s), and detailed information about that bundle, including required bundles/packages, exported bundles, links to javadocs for exported packages, extension points defined/exposed, OSGi Services exposed, and links to source (downloading and browsing).

ECF Core

The ECF Core API provides support for all other ECF APIs. This includes identity (ID) services, ECF distributed container (IContainer) interface definition and instance creation.

API Bundles

org.eclipse.ecf.identity

org.eclipse.ecf

Project Sets

Anonymous

Committer

Test Bundles

org.eclipse.ecf.tests

Datashare API

The datashare API provides support for asynchronous messaging channels. Arbitrary data may be reliably sent to publish-and-subscribe channels.

API Bundle

org.eclipse.ecf.datashare

API + Provider Project Sets

Anonymous

Committer

Test Bundles

org.eclipse.ecf.tests.datashare

Discovery API

The discovery API provides a protocol independent API for discovering remote services.

API Bundle

org.eclipse.ecf.discovery

Provider Implementations

API Project Sets

Anonymous

Committer

Test Bundles

org.eclipse.ecf.tests.discovery

File Transfer API

The filetransfer API provides support for both retrieving remote files, and initiating the sending of peer-to-peer file transfer.

API Bundles

org.eclipse.ecf.filetransfer

org.eclipse.ecf.provider.filetransfer

API + Provider Project Sets

Anonymous

Committer

Provider Implementations

Test Bundles

org.eclipse.ecf.tests.filetransfer

Presence API

The presence API provides a protocol independent API for instant messaging, basic presence/buddy lists/rosters display and management, and multi-user chat rooms.

API Bundle

org.eclipse.ecf.presence

Provider Implementations

API Project Sets

Anonymous

Committer

Test Bundles

org.eclipse.ecf.tests.presence

Remote Services API

The remote services API provides a protocol independent API for accessing remote services on peer OSGi containers. The remote services may be accessed via proxy, synchronous (call/return) invocation, or asynchronous (call and listen) invocation.

API Bundle

org.eclipse.ecf.remoteservice

Provider Implementations

API Project Sets

Anonymous

Committer

Test Bundles

org.eclipse.ecf.tests.remoteservice

Shared Object API

The shared object API provides a protocol independent API for replicating Java objects in a distributed group.

API Bundle

org.eclipse.ecf.sharedobject

Provider Implementations

API Project Sets

Anonymous

Committer

Test Bundles

org.eclipse.ecf.tests.sharedobject

Telephony API

The telephony API supports the initiation/receiving and management of VOIP phone calls.

TBD.