Ice 3.7 Slice API Reference
FileServer.ice
Go to the documentation of this file.
1 //
2 // Copyright (c) ZeroC, Inc. All rights reserved.
3 //
4 
5 #pragma once
6 
7 [["cpp:dll-export:ICEPATCH2_API"]]
8 [["cpp:doxygen:include:IcePatch2/IcePatch2.h"]]
9 [["cpp:header-ext:h"]]
10 [["cpp:include:IcePatch2/Config.h"]]
11 
12 [["ice-prefix"]]
13 
14 [["js:module:ice"]]
15 [["js:cjs-module"]]
16 
17 [["objc:header-dir:objc"]]
18 
19 [["python:pkgdir:IcePatch2"]]
20 
21 #include <IcePatch2/FileInfo.ice>
22 
23 #ifndef __SLICE2JAVA_COMPAT__
24 [["java:package:com.zeroc"]]
25 #endif
26 
34 ["objc:prefix:ICEPATCH2"]
35 module IcePatch2
36 {
37 
44 sequence<Ice::ByteSeq> ByteSeqSeq;
45 
52 {
53 }
54 
61 {
67  string reason;
68 }
69 
77 {
78 }
79 
85 interface FileServer
86 {
102  ["deprecate:getFileInfoSeq() is deprecated, use getLargeFileInfoSeq() instead.",
103  "nonmutating", "cpp:const"] idempotent FileInfoSeq getFileInfoSeq(int partition)
105 
117  ["nonmutating", "cpp:const"] idempotent LargeFileInfoSeq getLargeFileInfoSeq(int partition)
119 
131  ["nonmutating", "cpp:const"] idempotent ByteSeqSeq getChecksumSeq();
132 
141  ["nonmutating", "cpp:const"] idempotent Ice::ByteSeq getChecksum();
142 
164  ["deprecate:getFileCompressed() is deprecated, use getLargeFileCompressed() instead.",
165  "amd", "nonmutating", "cpp:const", "cpp:array"]
166  idempotent Ice::ByteSeq getFileCompressed(string path, int pos, int num)
168 
186  ["amd", "nonmutating", "cpp:const", "cpp:array"]
187  idempotent Ice::ByteSeq getLargeFileCompressed(string path, long pos, int num)
188  throws FileAccessException;
189 }
190 
191 }
Ice::ByteSeq
sequence< byte > ByteSeq
A sequence of bytes.
Definition: BuiltinSequences.ice:33
IcePatch2::ByteSeqSeq
sequence< Ice::ByteSeq > ByteSeqSeq
A sequence of byte sequences.
Definition: FileServer.ice:44
IcePatch2::FileAccessException::reason
string reason
An explanation of the reason for the failure.
Definition: FileServer.ice:67
IcePatch2::FileInfoSeq
sequence< FileInfo > FileInfoSeq
A sequence with information about many files.
Definition: FileInfo.ice:56
IcePatch2::FileServer::getChecksumSeq
idempotent ByteSeqSeq getChecksumSeq()
Return the checksums for all partitions.
IcePatch2::FileServer::getLargeFileInfoSeq
idempotent LargeFileInfoSeq getLargeFileInfoSeq(int partition)
Returns file information for the specified partition.
IcePatch2
IcePatch can be used to update file hierarchies in a simple and efficient manner.
Definition: FileInfo.ice:29
IcePatch2::FileSizeRangeException
This exception is raised if an operation tries to use a file whose size is larger than 2....
Definition: FileServer.ice:77
IcePatch2::FileServer::getChecksum
idempotent Ice::ByteSeq getChecksum()
Return the master checksum for all partitions.
IcePatch2::FileAccessException
This exception is raised if a file's contents cannot be read.
Definition: FileServer.ice:61
IcePatch2::FileServer
The interface that provides access to files.
Definition: FileServer.ice:86
IcePatch2::FileServer::getFileCompressed
idempotent Ice::ByteSeq getFileCompressed(string path, int pos, int num)
Read the specified file.
IcePatch2::FileServer::getFileInfoSeq
idempotent FileInfoSeq getFileInfoSeq(int partition)
Return file information for the specified partition.
IcePatch2::LargeFileInfoSeq
sequence< LargeFileInfo > LargeFileInfoSeq
A sequence with information about many files.
Definition: FileInfo.ice:83
IcePatch2::PartitionOutOfRangeException
A partition argument was not in the range 0-255.
Definition: FileServer.ice:52
IcePatch2::FileServer::getLargeFileCompressed
idempotent Ice::ByteSeq getLargeFileCompressed(string path, long pos, int num)
Read the specified file.
FileInfo.ice