Jump to: navigation, search

ECF/API Docs

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 of these APIs is provided via a distinct set of bundles, listed under its corresponding section.

Each API bundle has a link to information about that bundle, including required bundles/packages, exported bundles, 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.

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.

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.

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.