Caplin.DataSource.IPeer Interface Reference

Represents a DataSource peer. More...

Public Member Functions
void	SetStatusDown ()
	Stops this peer from making connections to its remote peer. More...
void	SetStatusUp ()
	Allow this peer to make connections to its remote peer. More...

Properties
int	Index [get]
	Gets the index of this peer. More...
string	Name [get]
	Gets the name of this peer. This is the name of the peer that the DataSource application is connected to. More...

Detailed Description

Represents a DataSource peer.

Member Function Documentation

void Caplin.DataSource.IPeer.SetStatusDown

(

)

Stops this peer from making connections to its remote peer.

If the peer is connected, this method disconnects it.

void Caplin.DataSource.IPeer.SetStatusUp

(

)

Allow this peer to make connections to its remote peer.

Property Documentation

int Caplin.DataSource.IPeer.Index

get

Gets the index of this peer.

The index.

Generally a DataSource application should not care about the index of the peer, however it does provide a unique identifier whilst the DataSource application is running.

string Caplin.DataSource.IPeer.Name

get

Gets the name of this peer. This is the name of the peer that the DataSource application is connected to.

The name.

It is possible for the name of the peer to change - the name returned here is provided by the remote peer which is user configurable on the remote peer.