Ice Reference Manual
<<< Previous	Slice Documentation	Next >>>

`IcePatch::Regular`

Overview

interface Regular
    extends 
	File

The interface for a regular file.

Operation Index

getBZ2: Obtains a portion of the compressed file.
getBZ2MD5: Obtain the message digest for a portion of the compressed file, allowing a client to determine whether a partially downloaded file is still valid.
getBZ2Size: Obtain the compressed size of the file.

`getBZ2`

::Ice::ByteSeq getBZ2(int pos,
    int num)
    throws
	FileAccessException,
	BusyException;

Obtains a portion of the compressed file.

Parameters

pos: The starting position in bytes. The position must not exceed the size of the file.
num: The maximum number of bytes to return. This number must not exceed one megabyte.

Return Value

The requested bytes. The returned sequence may contain fewer bytes than requested if getBZ2 exceeds the remaining bytes in the file.

Exceptions

FileAccessException: Raised if the file cannot be accessed.
BusyException: Raised if the server is busy.

`getBZ2MD5`

::Ice::ByteSeq getBZ2MD5(int size)
    throws
	FileAccessException,
	BusyException;

Obtain the message digest for a portion of the compressed file, allowing a client to determine whether a partially downloaded file is still valid.

Parameters

size: The number of bytes to use when computing the message digest.

Return Value

The number of bytes in the compressed representation of the file.

Exceptions

FileAccessException: Raised if the file cannot be accessed.
BusyException: Raised if the server is busy.

`getBZ2Size`

int getBZ2Size()
    throws
	FileAccessException,
	BusyException;

Obtain the compressed size of the file. IcePatch compresses files using the BZIP2 algorithm.

Return Value

The number of bytes in the compressed representation of the file.

Exceptions

FileAccessException: Raised if the file cannot be accessed.
BusyException: Raised if the server is busy.

<<< Previous	Home	Next >>>
`IcePatch::FileDesc`	Up	`IcePatch::RegularDesc`