Module syslog_socket

Description
Data Types
Function Index
Function Details

Erlang syslog Client Interface

A minimal syslog client interface that supports both RFC3164 and RFC5424.

Copyright © 2016 Michael Truog

Version: 0.1.0 Dec 23 2016 20:24:22 ------------------------------------------------------------------------

Behaviours: gen_server.

Authors: Michael Truog (mjtruog [at] gmail (dot) com).

Description

Erlang syslog Client Interface

A minimal syslog client interface that supports both RFC3164 and RFC5424.

Data Types

app_name()

app_name() = string()

facility()

facility() = kernel | user | mail | daemon | auth0 | syslog | print | news | uucp | clock0 | auth1 | ftp | ntp | auth2 | auth3 | clock1 | local0 | local1 | local2 | local3 | local4 | local5 | local6 | local7 | non_neg_integer()

message_id()

message_id() = string() | binary()

options()

options() = [{transport, transport()} | {transport_options, list()} | {protocol, protocol()} | {utf8, boolean()} | {facility, facility()} | {app_name, app_name()} | {host, inet:ip_address() | inet:hostname()} | {port, undefined | inet:port_number()} | {timeout, timeout_milliseconds()}]

priority()

priority() = emergency | alert | critical | error | warning | notice | informational | debug | non_neg_integer()

protocol()

protocol() = rfc3164 | rfc5424

timeout_milliseconds()

timeout_milliseconds() = 1..4294967295

transport()

transport() = udp | tcp | tls

Function Index

code_change/3
handle_call/3
handle_cast/2
handle_info/2
init/1
send/3	Send data to syslog without a timestamp or message_id. .
send/4	Send data to syslog without a message_id. .
send/5	Send data to syslog. .
start_link/1	Start a syslog socket. Connection is immediate within the new Erlang process.
stop_link/1	Stop an existing syslog socket asynchronously. .
stop_link/2	Stop an existing syslog socket synchronously. .
terminate/2

Function Details

code_change/3

code_change(X1, State, X3) -> any()

handle_call/3

handle_call(Request, X2, State) -> any()

handle_cast/2

handle_cast(Request, State) -> any()

handle_info/2

handle_info(Request, State) -> any()

init/1

init(X1) -> any()

send/3

send(Pid::pid(), Priority::priority(), Data::iodata()) -> ok

Send data to syslog without a timestamp or message_id.

send/4

send(Pid::pid(), Priority::priority(), Timestamp::undefined | erlang:timestamp(), Data::iodata()) -> ok

Send data to syslog without a message_id.

send/5

send(Pid::pid(), Priority::priority(), Timestamp::undefined | erlang:timestamp(), MessageId::message_id(), Data::iodata()) -> ok

Send data to syslog.

start_link/1

start_link(Options) -> any()

Start a syslog socket.

Connection is immediate within the new Erlang process.

stop_link/1

stop_link(Pid::pid()) -> ok

Stop an existing syslog socket asynchronously.

stop_link/2

stop_link(Pid::pid(), Timeout::timeout_milliseconds()) -> ok

Stop an existing syslog socket synchronously.

terminate/2

terminate(X1, State) -> any()

Generated by EDoc, Dec 23 2016, 20:24:22.