IcePatch2::FileServer Interface Reference

The interface that provides access to files. More...

Defined in <IcePatch2/FileServer.ice>

interface FileServer { ... }

Operations
idempotent Ice::ByteSeq	getChecksum ()
	Return the master checksum for all partitions. More...
idempotent ByteSeqSeq	getChecksumSeq ()
	Return the checksums for all partitions. More...
idempotent Ice::ByteSeq	getFileCompressed (string path, int pos, int num) throws FileAccessException, FileSizeRangeException
	Read the specified file. More...
idempotent FileInfoSeq	getFileInfoSeq (int partition) throws PartitionOutOfRangeException, FileSizeRangeException
	Return file information for the specified partition. More...
idempotent Ice::ByteSeq	getLargeFileCompressed (string path, long pos, int num) throws FileAccessException
	Read the specified file. More...
idempotent LargeFileInfoSeq	getLargeFileInfoSeq (int partition) throws PartitionOutOfRangeException
	Returns file information for the specified partition. More...

Detailed Description

The interface that provides access to files.

Operation Documentation

getChecksum()

["nonmutating","cpp:const"]

idempotent Ice::ByteSeq getChecksum

(

)

Return the master checksum for all partitions.

If this checksum is the same as for a previous run, the entire file set is up-to-date.

Returns

The master checksum for the file set.

getChecksumSeq()

["nonmutating","cpp:const"]

idempotent ByteSeqSeq getChecksumSeq

(

)

Return the checksums for all partitions.

Returns

A sequence containing 256 checksums. Partitions with a checksum that differs from the previous checksum for the same partition contain updated files. Partitions with a checksum that is identical to the previous checksum do not contain updated files.

getFileCompressed()

["deprecate:getFileCompressed() is deprecated, use getLargeFileCompressed() instead.","amd","nonmutating","cpp:const","cpp:array"]

idempotent Ice::ByteSeq getFileCompressed	(	string	path,
		int	pos,
		int	num
	)		throws FileAccessException, FileSizeRangeException

Read the specified file.

This operation may only return fewer bytes than requested in case there was an end-of-file condition.

This operation is deprecated and only present for compatibility with old Ice clients (older than version 3.6).

Parameters

path	The pathname (relative to the data directory) for the file to be read.
pos	The file offset at which to begin reading.
num	The number of bytes to be read.

Returns

A sequence containing the compressed file contents.

Exceptions

FileAccessException	If an error occurred while trying to read the file.
FileSizeRangeException	If a file is larger than 2.1GB.

getFileInfoSeq()

["deprecate:getFileInfoSeq() is deprecated, use getLargeFileInfoSeq() instead.","nonmutating","cpp:const"]

idempotent FileInfoSeq getFileInfoSeq

(

int

partition

)

throws PartitionOutOfRangeException, FileSizeRangeException

Return file information for the specified partition.

This operation is deprecated and only present for compatibility with old Ice clients (older than version 3.6).

Parameters

partition

The partition number in the range 0-255.

Returns

A sequence containing information about the files in the specified partition.

Exceptions

PartitionOutOfRangeException	If the partition number is out of range.
FileSizeRangeException	If a file is larger than 2.1GB.

getLargeFileCompressed()

["amd","nonmutating","cpp:const","cpp:array"]

idempotent Ice::ByteSeq getLargeFileCompressed	(	string	path,
		long	pos,
		int	num
	)		throws FileAccessException

Read the specified file.

This operation may only return fewer bytes than requested in case there was an end-of-file condition.

Parameters

path	The pathname (relative to the data directory) for the file to be read.
pos	The file offset at which to begin reading.
num	The number of bytes to be read.

Returns

A sequence containing the compressed file contents.

Exceptions

FileAccessException

If an error occurred while trying to read the file.

getLargeFileInfoSeq()

["nonmutating","cpp:const"]

idempotent LargeFileInfoSeq getLargeFileInfoSeq

(

int

partition

)

throws PartitionOutOfRangeException

Returns file information for the specified partition.

Parameters

partition

The partition number in the range 0-255.

Returns

A sequence containing information about the files in the specified partition.

Exceptions

PartitionOutOfRangeException

If the partition number is out of range.

---

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

• IcePatch2/FileServer.ice