Joedb 9.1.3
The Journal-Only Embedded Database
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
joedb::Client Class Referenceabstract

Handle concurrent access to a file with a joedb::Connection. More...

#include <joedb/concurrency/Client.h>

Inheritance diagram for joedb::Client:
Inheritance graph
[legend]

Public Member Functions

 Client (Readonly_Journal &journal, Connection &connection, bool content_check=true)
 
bool is_readonly () const
 
const Readonly_Journalget_journal () const
 
int64_t get_checkpoint () const
 
std::string read_blob_data (Blob blob) const
 
int64_t get_server_checkpoint () const
 
int64_t get_checkpoint_difference () const
 
int64_t pull (std::chrono::milliseconds wait=std::chrono::milliseconds(0))
 
void push_unlock ()
 
virtual ~Client ()
 

Protected Member Functions

virtual void read_journal ()=0
 
template<typename F >
void transaction (F transaction)
 

Friends

class Client_Lock
 

Detailed Description

Definition at line 11 of file Client.h.

Constructor & Destructor Documentation

◆ Client()

joedb::Client::Client ( Readonly_Journal journal,
Connection connection,
bool  content_check = true 
)
inline

Definition at line 82 of file Client.h.

◆ ~Client()

joedb::Client::~Client ( )
virtualdefault

Member Function Documentation

◆ get_checkpoint()

int64_t joedb::Client::get_checkpoint ( ) const
inline

Definition at line 109 of file Client.h.

◆ get_checkpoint_difference()

int64_t joedb::Client::get_checkpoint_difference ( ) const
inline

Definition at line 124 of file Client.h.

◆ get_journal()

const Readonly_Journal & joedb::Client::get_journal ( ) const
inline

Definition at line 104 of file Client.h.

◆ get_server_checkpoint()

int64_t joedb::Client::get_server_checkpoint ( ) const
inline

Definition at line 119 of file Client.h.

◆ is_readonly()

bool joedb::Client::is_readonly ( ) const
inline

Definition at line 99 of file Client.h.

◆ pull()

int64_t joedb::Client::pull ( std::chrono::milliseconds  wait = std::chrono::milliseconds(0))
inline
Parameters
waitindicates how long the connection may wait for new data
Return values
pull_sizenumber of bytes pulled

Definition at line 131 of file Client.h.

◆ push_unlock()

void joedb::Client::push_unlock ( )
inline

Definition at line 152 of file Client.h.

◆ read_blob_data()

std::string joedb::Client::read_blob_data ( Blob  blob) const
inline

Definition at line 114 of file Client.h.

◆ read_journal()

virtual void joedb::Client::read_journal ( )
protectedpure virtual

◆ transaction()

template<typename F >
void joedb::Client::transaction ( transaction)
inlineprotected

Definition at line 18 of file Client.h.

Friends And Related Symbol Documentation

◆ Client_Lock

friend class Client_Lock
friend

Definition at line 13 of file Client.h.


The documentation for this class was generated from the following files: