|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ISqlJetFile
OS Interface Open File Handle. An ISqlJetFile object represents an open file in the OS interface layer. Individual OS interface implementations will want to subclass this object by appending additional fields for their own use.
Field Summary | |
---|---|
static long |
PENDING_BYTE
|
static long |
RESERVED_BYTE
|
static long |
SHARED_FIRST
|
static long |
SHARED_SIZE
|
Method Summary | |
---|---|
boolean |
checkReservedLock()
This routine checks if there is a RESERVED lock held on the specified file by this or any other process. |
void |
close()
Close a file. |
java.util.Set<SqlJetDeviceCharacteristics> |
deviceCharacteristics()
Return the device characteristics for the file. |
long |
fileSize()
Determine the current size of a file in bytes |
SqlJetFileType |
getFileType()
Returns file type. |
SqlJetLockType |
getLockType()
Returns lock type of file. |
java.util.Set<SqlJetFileOpenPermission> |
getPermissions()
Returns assiciated permissions. |
boolean |
isMemJournal()
Return true if the file-handle passed as an argument is an in-memory journal |
boolean |
lock(SqlJetLockType lockType)
Lock the file with the lock specified by parameter locktype - one of the following: (1) SHARED (2) RESERVED (3) PENDING (4) EXCLUSIVE Sometimes when requesting one lock state, additional lock states are inserted in between. |
int |
read(ISqlJetMemoryPointer buffer,
int amount,
long offset)
Read data from a file into a buffer. |
int |
sectorSize()
Return the sector size in bytes of the underlying block device for the specified file. |
void |
sync(java.util.Set<SqlJetSyncFlags> syncFlags)
Make sure all writes to a particular file are committed to disk. |
void |
truncate(long size)
Truncate an open file to a specified size |
boolean |
unlock(SqlJetLockType lockType)
Lower the locking level on file descriptor pFile to locktype. |
void |
write(ISqlJetMemoryPointer buffer,
int amount,
long offset)
Write data from a buffer into a file. |
Field Detail |
---|
static final long PENDING_BYTE
static final long RESERVED_BYTE
static final long SHARED_FIRST
static final long SHARED_SIZE
Method Detail |
---|
SqlJetFileType getFileType()
SqlJetFileType
java.util.Set<SqlJetFileOpenPermission> getPermissions()
SqlJetFileOpenPermission
void close() throws SqlJetException
SqlJetException
int read(ISqlJetMemoryPointer buffer, int amount, long offset) throws SqlJetIOException
buffer
- amount
- offset
-
SqlJetIOException
void write(ISqlJetMemoryPointer buffer, int amount, long offset) throws SqlJetIOException
buffer
- amount
- offset
-
SqlJetIOException
void truncate(long size) throws SqlJetIOException
size
-
SqlJetIOException
void sync(java.util.Set<SqlJetSyncFlags> syncFlags) throws SqlJetIOException
dataOnly
- full
-
SqlJetIOException
long fileSize() throws SqlJetException
SqlJetException
boolean lock(SqlJetLockType lockType) throws SqlJetIOException
lockType
-
SqlJetIOException
boolean unlock(SqlJetLockType lockType) throws SqlJetIOException
lockType
-
SqlJetIOException
boolean checkReservedLock()
SqlJetLockType getLockType()
int sectorSize()
java.util.Set<SqlJetDeviceCharacteristics> deviceCharacteristics()
boolean isMemJournal()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |