libfossil
fsl_xfer_config Struct Reference

Various configuration pieces for libfossil sync transfer subsystem. More...

#include "sync.h"

Collaboration diagram for fsl_xfer_config:

Data Fields

bool compressTraffic
 If true, use the application/x-fossil-uncompressed Content-Type for communication, else use application/x-fossil (which fossil does not compress).
fsl_xfer_dbg debug
 Optional debug message callback.
bool leaveTempFiles
 A hint for fsl_sc channels which support it.
fsl_msg_listener listener
 When a sync operation happens on a transient fs_cx instance, e.g.
int32_t maxResponseBytes
 NYI!
int8_t maxResponseSeconds
 NYI!
struct { 
   fsl_xfer_metrics_f   callback 
 If not NULL, fsl__xfer's cleanup routine will call this, passing it the metrics, this->state, and the final result code of the sync process. More...
   void *   state 
 Optional state for the 2nd argument to this->callback(). More...
} metrics
struct { 
   bool   autosync 
   short   clone 
   bool   privateContent 
   bool   pull 
   bool   push 
   bool   verily 
} op
 Members which are set to true will activate specific aspects of sync.
struct { 
   fsl_pw_f   callback 
 Callback to use to fetch passwords. More...
   bool   save 
 If true: More...
   void *   state 
 State for the password callback. More...
} password
struct { 
   fsl_flag32_t   mask 
 If non-zero, a tracing channel is installed with the given mask of fsl_sc_tracer_e flags. More...
   fsl_outputer   outputer 
 The output sink. More...
} trace
 fsl_sc API tracing hook.
char const * url
 The URL or filename to sync with.
short verbosity
 Verbosity level (higher is more verbose).

Detailed Description

Various configuration pieces for libfossil sync transfer subsystem.

Definition at line 1554 of file sync.h.

Field Documentation

◆ autosync

bool fsl_xfer_config::autosync

Definition at line 1640 of file sync.h.

◆ callback [1/2]

fsl_pw_f fsl_xfer_config::callback

Callback to use to fetch passwords.

Definition at line 1663 of file sync.h.

◆ callback [2/2]

fsl_xfer_metrics_f fsl_xfer_config::callback

If not NULL, fsl__xfer's cleanup routine will call this, passing it the metrics, this->state, and the final result code of the sync process.

Definition at line 1651 of file sync.h.

◆ clone

short fsl_xfer_config::clone

Definition at line 1632 of file sync.h.

◆ compressTraffic

bool fsl_xfer_config::compressTraffic

If true, use the application/x-fossil-uncompressed Content-Type for communication, else use application/x-fossil (which fossil does not compress).

This is a hint to the server, which may response how it likes.

NYI is compression of outbound traffic.

Definition at line 1594 of file sync.h.

◆ debug

fsl_xfer_dbg fsl_xfer_config::debug

Optional debug message callback.

Definition at line 1608 of file sync.h.

◆ leaveTempFiles

bool fsl_xfer_config::leaveTempFiles

A hint for fsl_sc channels which support it.

See FSL_SC_F_LEAVE_TEMP_FILES.

Definition at line 1584 of file sync.h.

◆ listener

fsl_msg_listener fsl_xfer_config::listener

When a sync operation happens on a transient fs_cx instance, e.g.

during a clone operation into a new fsl_cx, this listener gets installed in the transient fsl_cx. Sync operations which happen in the context of a specific fsl_cx currently use that instance's message listener. "The plan" is to eventually allow an override of the listener for sync-specific messages, but that is not yet in place.

Definition at line 1605 of file sync.h.

◆ mask

fsl_flag32_t fsl_xfer_config::mask

If non-zero, a tracing channel is installed with the given mask of fsl_sc_tracer_e flags.

If it is zero, no tracer is installed.

Definition at line 1619 of file sync.h.

◆ maxResponseBytes

int32_t fsl_xfer_config::maxResponseBytes

NYI!

Approximate max size, in bytes, for outbound response payloads. It may overstep this amount by a single artifact (which may be arbitrarily large).

Definition at line 1573 of file sync.h.

◆ maxResponseSeconds

int8_t fsl_xfer_config::maxResponseSeconds

NYI!

Max amount of time, in seconds, to spend generating a single response.

Definition at line 1566 of file sync.h.

◆ [struct]

struct { ... } fsl_xfer_config::metrics

◆ [struct]

struct { ... } fsl_xfer_config::op

Members which are set to true will activate specific aspects of sync.

◆ outputer

fsl_outputer fsl_xfer_config::outputer

The output sink.

Definition at line 1623 of file sync.h.

◆ [struct]

struct { ... } fsl_xfer_config::password

◆ privateContent

bool fsl_xfer_config::privateContent

Definition at line 1638 of file sync.h.

◆ pull

bool fsl_xfer_config::pull

Definition at line 1636 of file sync.h.

◆ push

bool fsl_xfer_config::push

Definition at line 1634 of file sync.h.

◆ save

bool fsl_xfer_config::save

If true:

  • If the URL contains a password, then on successful sync the hashed password is saved for future use with that same URL (excluding the password part).
  • If the URL has no password but a saved one is found, it is used.

Definition at line 1679 of file sync.h.

◆ state

void* fsl_xfer_config::state

Optional state for the 2nd argument to this->callback().

State for the password callback.

It is owned by whoever assigns it to non-NULL.

It must match that implementation's expectations.

Definition at line 1656 of file sync.h.

◆ [struct]

struct { ... } fsl_xfer_config::trace

fsl_sc API tracing hook.

◆ url

char const* fsl_xfer_config::url

The URL or filename to sync with.

If this is NULL then the library will try to determine it from the currently-opened repository.

Definition at line 1560 of file sync.h.

◆ verbosity

short fsl_xfer_config::verbosity

Verbosity level (higher is more verbose).

Definition at line 1578 of file sync.h.

◆ verily

bool fsl_xfer_config::verily

Definition at line 1642 of file sync.h.


The documentation for this struct was generated from the following file: