Simias::Sync::SyncClient Class Reference

Class that manages the synchronization for all collection. More...

Inheritance diagram for Simias::Sync::SyncClient:

[legend]

Collaboration diagram for Simias::Sync::SyncClient:

[legend]

List of all members.

Public Member Functions
void	TimeToSync (object collectionClient)
	Called by The CollectionSyncClient when it is time to run another sync pass.
void	Start ()
	Starts the Sync client.
void	Resume ()
	Resumes a paused sync.
void	Pause ()
	Pauses the synchronization service.
int	Custom (int message, string data)
	Used to send custom control messages to the service. Not used.
void	Stop ()
	Called to stop the synchronization service.
Static Public Member Functions
static void	GetCountToSync (string collectionID, out uint fileCount)
	Returns the number of bytes to sync to the server.
static void	ScheduleSync (string collectionID)
	Call to schedule the collection to sync.
static void	RescheduleAllColSync (string DomainID)
	Called to schedule a sync operation for all collections and domain. done immediately after login.
static void	ResetConnections (string DomainID)
	Reset the connection for the domain.
static DateTime	GetLastSyncTime (string collectionID)
	Get the last time the Collection was in sync.
static void	Stop (string collectionID)
	Stop the.
static bool	ServerUnavailable (string collectionID)
	Gets the state of the server for this collection.
Properties
static string	CurrentiFolderID [get, set]
	Get/Set Method for Current iFolder ID.

---

Detailed Description

Class that manages the synchronization for all collection.

---

Member Function Documentation

void Simias::Sync::SyncClient::TimeToSync

(

object

collectionClient

)

[inline]

Called by The CollectionSyncClient when it is time to run another sync pass.

Parameters:

collectionClient

The client that is ready to sync.

static void Simias::Sync::SyncClient::GetCountToSync	(	string	collectionID,
		out uint	fileCount
	)			[inline, static]

Returns the number of bytes to sync to the server.

Parameters:

	collectionID
	fileCount	Returns the number of nodes to sync to the server.

static void Simias::Sync::SyncClient::ScheduleSync

(

string

collectionID

)

[inline, static]

Call to schedule the collection to sync.

Parameters:

collectionID

The collection to sync.

static void Simias::Sync::SyncClient::RescheduleAllColSync

(

string

DomainID

)

[inline, static]

Called to schedule a sync operation for all collections and domain. done immediately after login.

static void Simias::Sync::SyncClient::ResetConnections

(

string

DomainID

)

[inline, static]

Reset the connection for the domain.

Parameters:

DomainID

ID of the domain

check the authenticated status of the domain...

static DateTime Simias::Sync::SyncClient::GetLastSyncTime

(

string

collectionID

)

[inline, static]

Get the last time the Collection was in sync.

Parameters:

collectionID

The collection to query.

Returns:

The last time the collection was in sync.

static void Simias::Sync::SyncClient::Stop

(

string

collectionID

)

[inline, static]

Stop the.

Parameters:

collectionID

static bool Simias::Sync::SyncClient::ServerUnavailable

(

string

collectionID

)

[inline, static]

Gets the state of the server for this collection.

Parameters:

collectionID

The collection to check.

Returns:

True if the server is unavailable

void Simias::Sync::SyncClient::Start

(

)

[inline]

Starts the Sync client.

Parameters:

conf

The configuration object to use.

Implements Simias::Service::IThreadService.

void Simias::Sync::SyncClient::Resume

(

)

[inline]

Resumes a paused sync.

Implements Simias::Service::IThreadService.

void Simias::Sync::SyncClient::Pause

(

)

[inline]

Pauses the synchronization service.

Implements Simias::Service::IThreadService.

int Simias::Sync::SyncClient::Custom	(	int	message,
		string	data
	)			[inline]

Used to send custom control messages to the service. Not used.

Parameters:

	message	The custom message.
	data	The data of the message.

Implements Simias::Service::IThreadService.

void Simias::Sync::SyncClient::Stop

(

)

[inline]

Called to stop the synchronization service.

Implements Simias::Service::IThreadService.

---

Property Documentation

string Simias::Sync::SyncClient::CurrentiFolderID [static, get, set]

Get/Set Method for Current iFolder ID.

---

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

• src/core/Sync/SyncClient.cs