File SolidSyslogFile.h¶

FileList > Core > Interface > SolidSyslogFile.h

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

Detailed Description¶

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

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

Public Functions Documentation¶

SolidSyslogFile_Close¶

void SolidSyslogFile_Close (
    struct SolidSyslogFile * file
)

SolidSyslogFile_Delete¶

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

SolidSyslogFile_Exists¶

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

SolidSyslogFile_IsOpen¶

bool SolidSyslogFile_IsOpen (
    struct SolidSyslogFile * file
)

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
)

SolidSyslogFile_Read¶

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

SolidSyslogFile_SeekTo¶

void SolidSyslogFile_SeekTo (
    struct SolidSyslogFile * file,
    size_t offset
)

SolidSyslogFile_Size¶

size_t SolidSyslogFile_Size (
    struct SolidSyslogFile * file
)

SolidSyslogFile_Truncate¶

void SolidSyslogFile_Truncate (
    struct SolidSyslogFile * file
)

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