group
group__libshare__fsaux
Provices the core data storage functionality.

Auxiliary Binary Storage

function
int shfs_aux_read
(shfs_ino_t *inode, shbuf_t *ret_buff)
Retrieve a full data segment of a sharefs filesystem inode.
Param
inode
The inode whose data is being retrieved.
ret_buff
The return buffer.
shbuf_t structshbuf__t compound
Return Value
A zero (0) on success or an libshare error code no failure.
function
int shfs_aux_pread
(shfs_ino_t *inode, shbuf_t *ret_buff, off_t seek_of, size_t seek_max)
Retrieve a full or partial data segment of a sharefs filesystem inode.
Param
inode
The inode whose data is being retrieved.
ret_buff
The return buffer.
shbuf_t structshbuf__t compound
seek_of
The offset to begin reading data from the inode.
seek_max
The length of data to be read or zero (0) to indicate no limit.
Return Value
A zero (0) on success or an libshare error code no failure.
function
int shfs_aux_write
(shfs_ino_t *inode, shbuf_t *buff)
Stores a full data segment to a sharefs filesystem inode.
Param
inode
The inode whose data is being retrieved.
buff
The data segment to write to the inode.
Return Value
A zero (0) on success or an libshare error code no failure.
Note
A inode must be linked before it can be written to.
function
int shfs_aux_pwrite
(shfs_ino_t *inode, shbuf_t *buff, off_t seek_of, size_t seek_max)
Stores a full or partial data segment to a sharefs filesystem inode.
Param
inode
The inode whose data is being retrieved.
buff
The data segment to write to the inode.
seek_of
The offset to begin writing data to the inode.
seek_max
The length of data to be write or zero (0) to indicate no limit.
Return Value
A zero (0) on success or an libshare error code no failure.
Note
A inode must be linked before it can be written to.
function
ssize_t shfs_aux_pipe
(shfs_ino_t *inode, int fd)
Writes the auxillary contents of the inode to the file descriptor.
Param
inode
The sharefs filesystem inode to print from.
fd
A posix file descriptor number representing a socket or local filesystem file reference.
Return Value
The size of the bytes written or a SHERR_XX error code on error. On error one of the following error codes will be set: SHERR_BADF fd is not a valid file descriptor or is not open for writing.
function
uint64_t shfs_aux_crc
(shfs_ino_t *inode)