IcePatch::Directory

Overview

interface Directory
    extends 
	File

The interface for a directory.

Operation Index

getContents

Obtain descriptions for the immediate children of the directory.

getTotal

Obtain the total number of bytes to be downloaded for a particular configuration.

getContents

FileDescSeq getContents()
    throws
	FileAccessException,
	BusyException;

Obtain descriptions for the immediate children of the directory. This operation does not return the contents of subdirectories.

Return Value

The descriptions, each of which can be downcast to RegularDesc or DirectoryDesc.

Exceptions

FileAccessException

Raised if a file or directory cannot be accessed.

BusyException

Raised if the server is busy.

getTotal

long getTotal(::Ice::ByteSeq md5)
    throws
	FileAccessException,
	BusyException;

Obtain the total number of bytes to be downloaded for a particular configuration.

Parameters

md5

The message digest of the client's existing configuration. If the given sequence is empty, then the return value represents the size of the entire directory, including all subdirectories. If the sequence is not empty, and the message digest corresponds to a configuration that is known by the server, then the return value represents the number of bytes to be downloaded in order to update the client's directory to match the server's.

Return Value

The sum in bytes of the sizes of all BZ2 files to be downloaded for the configuration. If the given message digest does not match any known configurations, -1 is returned.

Exceptions

FileAccessException

Raised if a file or directory cannot be accessed.

BusyException

Raised if the server is busy.