Version: 7.8.0
Engines::fileTransfer Interface Reference

Interface of fileTransfer. More...

import "SALOME_Component.idl";

Inheritance diagram for Engines::fileTransfer:

Public Member Functions

long open (in string fileName)
 Open the file transfer. More...
 
long openW (in string fileName)
 Open the file transfer in write mode for file fileName. More...
 
void close (in long fileId)
 Close the file transfer. More...
 
fileBlock getBlock (in long fileId)
 Get a file data block. More...
 
void putBlock (in long fileId, in fileBlock block)
 Put a file data block. More...
 
void Register ()
 Increase the reference count (mark as used by another object). More...
 
void UnRegister ()
 Decrease the reference count (release by another object). More...
 
void Destroy ()
 Obsolete, left for compatibility reasons only. More...
 

Detailed Description

Interface of fileTransfer.

The fileTransfer and fileRef interfaces provide a file transfer service between different computers.

Member Function Documentation

void Engines::fileTransfer::close ( in long  fileId)

Close the file transfer.

when the file transfer is finished, close method releases structures created by open method, identified by fileId.

void SALOME::GenericObj::Destroy ( )
inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

fileBlock Engines::fileTransfer::getBlock ( in long  fileId)

Get a file data block.

Get successive blocks of octets from the original file. The last block is empty, and identifies the end of file.

long Engines::fileTransfer::open ( in string  fileName)

Open the file transfer.

open method returns a key (fileId) that identifies the structure (ex: C FILE), associated to the original file on the server. The structure is created by a container for transfer of files availables on the computer which runs the container. Each open gives a unique fileId, to allow concurrent reads of the same File.

long Engines::fileTransfer::openW ( in string  fileName)

Open the file transfer in write mode for file fileName.

Parameters
fileNamethe file to copy into with putBlock
Returns
the id to use with putBlock
void Engines::fileTransfer::putBlock ( in long  fileId,
in fileBlock  block 
)

Put a file data block.

Parameters
fileIdidentification of the file obtained by openW
blocka data block to copy into the file identified by fileId
void SALOME::GenericObj::Register ( )
inherited

Increase the reference count (mark as used by another object).

void SALOME::GenericObj::UnRegister ( )
inherited

Decrease the reference count (release by another object).