IStorageService Interface Reference


Description

This is the part of the interface to the Storage Service that is not public.

See also:
IToiStorageService
IToiStorageObserver

import "IStorageService.idl";

List of all members.

Public Member Functions

void RegisterObserverInternal (in string address) raises (TToiInvalidArgumentException)
void GetReservedFileSystemLocation (out string path)
void TriggerDevicePartitionFullCheck ()
void GetStorageOperationManager (out string address)
void GetStorageDeviceIds (out TToiStorageDeviceIdSequence identifiers)
void GetStorageDevice (in IToiStorageDevice::TToiStorageDeviceId id, out string address) raises (TToiInvalidArgumentException)
void Copy (in IToiOperationManager::TToiOperationId operationId, in string source, in string target) raises (TToiInvalidArgumentException)
void Move (in IToiOperationManager::TToiOperationId operationId, in string source, in string target) raises (TToiInvalidArgumentException)
void CreateFile (in IToiApplicationService::TToiApplicationId applicationId, in string fileName, in IToiStorageFile::TToiStorageFileType fileType, out string address) raises (TToiInvalidArgumentException, TToiFileException)
void RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException)
void ReleaseObserver (in string address) raises (TToiInvalidArgumentException)

Public Types

typedef sequence
< IToiStorageDevice::TToiStorageDeviceId
TToiStorageDeviceIdSequence

Member Typedef Documentation

Sequence of storage identifiers.


Member Function Documentation

void IToiStorageService::Copy ( in IToiOperationManager::TToiOperationId  operationId,
in string  source,
in string  target 
) raises (TToiInvalidArgumentException) [inherited]

Copies a file from source to target.

Parameters:
operationId Operation identifier, created by the operation manager.
source Source file path.
target Target path.
Exceptions:
TToiInvalidArgumentException Raised if the operationId is illegal.
void IToiStorageService::CreateFile ( in IToiApplicationService::TToiApplicationId  applicationId,
in string  fileName,
in IToiStorageFile::TToiStorageFileType  fileType,
out string  address 
) raises (TToiInvalidArgumentException, TToiFileException) [inherited]

Creates a file. A limited number of simultaneous IToiStorageFile objects are allowed. This functionality is primarily interesting for non C++ appliations (such as portal) that do not have access to the file system directly.

Parameters:
applicationId The identifier of the calling application.
fileName The name of the file. Note: If the filetype is IToiStorageFile::FILE_TYPE_TEMPORARY, a unique random string is automatically added to the end of the filename (but before any extension). The purpose of the filename in such case would merely be to describe its file-extension (e.g. '.jpeg').
fileType The type of file to be created.
Return values:
address The address to the IToiStorageFile instance.
Exceptions:
TToiInvalidArgumentException Raised if the fileType is invalid.
TToiFileException Raised if files cannot be created, i.e. no internal drive, no directory set up for temporary files, or the maximum number of simultaneous file objects is exceeded.
void IStorageService::GetReservedFileSystemLocation ( out string  path  ) 

Get the full path to the file system with space reserved for databases and other metadata.

Parameters:
path Full path to the file system mount point.
void IToiStorageService::GetStorageDevice ( in IToiStorageDevice::TToiStorageDeviceId  id,
out string  address 
) raises (TToiInvalidArgumentException) [inherited]

Returns the address to the storage device handler for a given storage identifier.

Parameters:
id Storage identifier.
Return values:
address Address to the IToiStorageDevice.
void IToiStorageService::GetStorageDeviceIds ( out TToiStorageDeviceIdSequence  identifiers  )  [inherited]

Returns the identifiers for the currently connected storage devices.

Return values:
identifiers The storage identifiers.
void IToiStorageService::GetStorageOperationManager ( out string  address  )  [inherited]

Returns the operation manager that handles asynchronous operations for this storage device.

Return values:
address Address to the IToiOperationManager.
void IToiStorageService::Move ( in IToiOperationManager::TToiOperationId  operationId,
in string  source,
in string  target 
) raises (TToiInvalidArgumentException) [inherited]

Moves a file from source to target.

Parameters:
operationId Operation identifier, created by operation manager.
source Source file path.
target Target path.
Exceptions:
TToiInvalidArgumentException Raised if the operationId is illegal.
void IToiStorageService::RegisterObserver ( in IToiApplicationService::TToiApplicationId  applicationId,
in string  address 
) raises (TToiInvalidArgumentException) [inherited]

Register an observer of type IToiStorageObserver. The observer will receive events sent by this IToiStorageService instance.

Parameters:
applicationId The identifier of the observing application.
address The address where the IToiStorageService can find an IToiStorageObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid or if the application has already registered itself as an observer with the same address.
See also:
IToiStorageObserver
void IStorageService::RegisterObserverInternal ( in string  address  )  raises (TToiInvalidArgumentException)

This function works the same way as the RegisterObserver in IToiStorageService. It should be used by platform services since no application id is needed.

Parameters:
address The address to the observer implementing the IToiStorageObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiStorageService::RegisterObserver
IToiStorageObserver
void IToiStorageService::ReleaseObserver ( in string  address  )  raises (TToiInvalidArgumentException) [inherited]

Release an observer previously registered with RegisterObserver.

Parameters:
address The address where the IToiStorageService can find the registered IToiStorageObserver interface.
Exceptions:
TToiInvalidArgumentException Raised if the specified address is invalid.
See also:
IToiStorageObserver
void IStorageService::TriggerDevicePartitionFullCheck (  ) 

Triggers a check to see if a partition is full and notifies observers if it is full or if it isn't full any more.