File SolidSyslogFile.h¶

FileList > Core > Interface > SolidSyslogFile.h

The file role: byte-file I/O (Open / Close / IsOpen / Read / Write / SeekTo / Size / Truncate / Exists / Delete) backing the store. More...

#include "ExternC.h"
#include <stdbool.h>
#include <stddef.h>

Public Functions¶

Type	Name
void	SolidSyslogFile_Close (struct SolidSyslogFile * file)
bool	SolidSyslogFile_Delete (struct SolidSyslogFile * file, const char * path)
bool	SolidSyslogFile_Exists (struct SolidSyslogFile * file, const char * path)
bool	SolidSyslogFile_IsOpen (struct SolidSyslogFile * file)
bool	SolidSyslogFile_Open (struct SolidSyslogFile * file, const char * path) These dispatch straight to the SolidSyslogFile vtable; the per-operation contract (open-or-create, exact-count Read/Write, durable Write, seek and truncate semantics) lives inSolidSyslogFileDefinition.h .
bool	SolidSyslogFile_Read (struct SolidSyslogFile * file, void * buf, size_t count)
void	SolidSyslogFile_SeekTo (struct SolidSyslogFile * file, size_t offset)
size_t	SolidSyslogFile_Size (struct SolidSyslogFile * file)
void	SolidSyslogFile_Truncate (struct SolidSyslogFile * file)
bool	SolidSyslogFile_Write (struct SolidSyslogFile * file, const void * buf, size_t count)

Detailed Description¶

These calls dispatch to the injected file's vtable, so behaviour is that file's.

Public Functions Documentation¶

function SolidSyslogFile_Close¶

void SolidSyslogFile_Close (
    struct SolidSyslogFile * file
)

function SolidSyslogFile_Delete¶

bool SolidSyslogFile_Delete (
    struct SolidSyslogFile * file,
    const char * path
)

function SolidSyslogFile_Exists¶

bool SolidSyslogFile_Exists (
    struct SolidSyslogFile * file,
    const char * path
)

function SolidSyslogFile_IsOpen¶

bool SolidSyslogFile_IsOpen (
    struct SolidSyslogFile * file
)

function SolidSyslogFile_Open¶

These dispatch straight to the SolidSyslogFile vtable; the per-operation contract (open-or-create, exact-count Read/Write, durable Write, seek and truncate semantics) lives inSolidSyslogFileDefinition.h .

bool SolidSyslogFile_Open (
    struct SolidSyslogFile * file,
    const char * path
)

function SolidSyslogFile_Read¶

bool SolidSyslogFile_Read (
    struct SolidSyslogFile * file,
    void * buf,
    size_t count
)

function SolidSyslogFile_SeekTo¶

void SolidSyslogFile_SeekTo (
    struct SolidSyslogFile * file,
    size_t offset
)

function SolidSyslogFile_Size¶

size_t SolidSyslogFile_Size (
    struct SolidSyslogFile * file
)

function SolidSyslogFile_Truncate¶

void SolidSyslogFile_Truncate (
    struct SolidSyslogFile * file
)

function SolidSyslogFile_Write¶

bool SolidSyslogFile_Write (
    struct SolidSyslogFile * file,
    const void * buf,
    size_t count
)

The documentation for this class was generated from the following file Core/Interface/SolidSyslogFile.h