CiscoStream.idl

Interface List

Module CiscoStream

Exceptions

RemoteIOException

Interface CiscoFileInputStream

CiscoStream.idl

Interface List

The file CiscoStream.idl contains the following interface:

CiscoStream::CiscoFileInputStream

Module CiscoStream

The CiscoStream defines a set of stream-like interfaces. Through those interfaces, a user can send and retrieve large blocks of data back and forth.

See Also

CiscoTaskManagedObjects.idl

Since

Cisco VPN Solutions Center, Release 1.1

Exceptions

RemoteIOException

RemoteIOException represents an exception because of server side IO error.

Usage

exception RemoteIOException
{
long errCode;
string errMessage;

};

Parameters

errCode---a long represents the type of error. errMessage---a string provides more detail description on the error.

Since

Cisco VPN Solutions Center, Release 1.1

Interface CiscoFileInputStream

CiscoFileInputStream represents a read-only stream of a file on the server. Usually, a client program read the Cisco VPN Solution Center log files through this interface.

See Also

TaskRuntimeAction::getActionOutputFileContent, TaskRuntimeActionGlobalState::getActionOutputFileContent

Since

Cisco VPN Solutions Center, Release 1.1

Operations

close()

Close the file on the server side and release the system resource.

Usage

void close();

Returns

Void

Since

Cisco VPN Solutions Center, Release 1.1

curOffset()

Gets the current offset in the stream

Usage

unsigned long curOffset();
raises(
RemoteIOException);

Returns

long represents the offset of the stream.

Raises

RemoteIOException if an IO error encoutered.

Since

Cisco VPN Solutions Center, Release 1.1

isEOF()

Checks if the end of file is reached.

Usage

boolean isEOF();
raises(
RemoteIOException);

Returns

true---if end of file is reached. false---otherwise.

Raises

RemoteIOException if an IO error encoutered.

Since

Cisco VPN Solutions Center, Release 1.1

isValid()

Checks if the file is successfully opened

Usage

boolean isValid();

Returns

true---if file is opened successfully. false---otherwise.

Since

Cisco VPN Solutions Center, Release 1.1

readln()

Reads a line of text from the stream.

Usage

string readln();
raises(
RemoteIOException);

Returns

a string represents a line of text. null if end of file reached.

Raises

RemoteIOException if an IO error encoutered.

Since

Cisco VPN Solutions Center, Release 1.1

seekTo()

Seeks to the a new position in the stream

Usage

void seekTo(
in unsigned long offset)

raises(
RemoteIOException);

Returns

Void

Raises

RemoteIOException if an IO error encoutered.

Since

Cisco VPN Solutions Center, Release 1.1

Table of Contents

CiscoStream.idl