General KERNEL Documentation     End User KERNEL Services  


Engines::fileTransfer Interface Reference

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

import "SALOME_Component.idl";


Public Member Functions

long open (in string fileName)
void close (in long fileId)
fileBlock getBlock (in long fileId)


Member Function Documentation

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

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.

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

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

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

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