Struct SyslogShared

pub struct SyslogShared<F: SyslogFormatter = DefaultSyslogFormatter, D: SyslogDestination = SyslogLocal> { /* private fields */ }

A single instance shared between all threads. A Mutex is used to guard the instance.

For this isntance a SyslogApi and StreamableSyslogApi are implemented.

Generics

• F - a SyslogFormatter which sets the instance which would format the message.

• D - a SyslogDestination instance which is either: SyslogLocal, [SyslogFile], [SyslogNet], [SyslogTls]. By default a SyslogLocal is selected.

Implementations

impl SyslogShared

pub fn openlog( ident: Option<&str>, logstat: LogStat, facility: LogFacility, net_tap_prov: SyslogLocal, ) -> SyRes<Self>

Opens a default connection to the local syslog server with default formatter.

In order to access the syslog API, use the SyslogApi.

Arguments

• ident - A program name which will appear on the logs. If none, will be determined automatically.

• logstat - LogStat an instance config.

• facility - LogFacility a syslog facility.

• net_tap_prov - a SyslogLocal instance with configuration.

Returns

A SyRes is returned (Result) with:

• Result::Ok - with instance

• Result::Err - with error description.

impl<F: SyslogFormatter, D: SyslogDestination> SyslogShared<F, D>

pub fn openlog_with( ident: Option<&str>, logstat: LogStat, facility: LogFacility, net_tap_prov: D, ) -> SyRes<SyslogShared<F, D>>

Opens a special connection to the destination syslog server with specific formatter.

All struct generic should be specified before calling this function.

In order to access the syslog API, use the SyslogApi.

Arguments

• ident - A program name which will appear on the logs. If none, will be determined automatically.

• logstat - LogStat an instance config.

• facility - LogFacility a syslog facility.

• net_tap_prov - a destination server. A specific D instance which contains infomation about the destination server. See syslog_provider.rs.

Returns

A SyRes is returned (Result) with:

• Result::Ok - with instance

• Result::Err - with error description.

Trait Implementations

impl<F: Clone + SyslogFormatter, D: Clone + SyslogDestination> Clone for SyslogShared<F, D>

fn clone(&self) -> SyslogShared<F, D>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Debug + SyslogFormatter, D: Debug + SyslogDestination> Debug for SyslogShared<F, D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: SyslogFormatter, D: SyslogDestination> StreamableSyslogApi<D, F, SyslogShared<F, D>> for SyslogShared<F, D>

fn make_stream(&self, pri: Priority) -> Box<dyn SyslogStream>

impl<F: SyslogFormatter, D: SyslogDestination> SyslogApi<F, D> for SyslogShared<F, D>

fn change_identity(&self, ident: &str) -> SyRes<()>

This function can be used to update the facility name, for example after fork().

Arguments

• ident - a new identity (up to 48 UTF8 chars)

fn connectlog(&self) -> SyRes<()>

Connects the current instance to the syslog server (destination).

fn setlogmask(&self, logmask: i32) -> SyRes<i32>

Sets the logmask to filter out the syslog calls.

fn closelog(&self) -> SyRes<()>

Closes connection to the syslog server (destination).

fn syslog(&self, pri: Priority, fmt: F)

Similar to libc, syslog() sends data to syslog server.

fn reconnect(&self) -> SyRes<()>

Re-opens the connection to the syslog server. Can be used to rotate logs(handle SIGHUP).

fn update_tap_data(&self, tap_data: D) -> SyRes<()>

Updates the instance’s socket. tap_data [TapTypeData] should be of the same variant (type) as current.

impl<F: SyslogFormatter, D: SyslogDestination> Send for SyslogShared<F, D>

impl<F: SyslogFormatter, D: SyslogDestination> Sync for SyslogShared<F, D>