rfc5424

type AppName string

type Client struct {
	// contains filtered or unexported fields
}

type ClientConfig struct {
	// MaxSize is the maximum allowed size for syslog messages sent
	// by the client. If not set then there is no maximum.
	MaxSize int

	// SendTImeout is the timeout that is used for each sent message.
	SendTimeout time.Duration
}

type Conn interface {
	io.Closer

	// Write writes the message to the connection.
	Write([]byte) (int, error)

	// SetWriteDeadline sets the absolute time after which any write
	// to the connection will time out.
	SetWriteDeadline(time.Time) error
}

type DialFunc func(network, address string) (Conn, error)

type Facility int

type Header struct {
	Priority

	// Timestamp indicates when the record was originally created.
	Timestamp Timestamp

	// Hostname identifies the machine that originally sent the
	// syslog message.
	Hostname Hostname

	// AppName identifies the device or application that originated
	// the syslog message.
	AppName AppName

	// ProcID is a value that is included in the message, having no
	// interoperable meaning, except that a change in the value
	// indicates there has been a discontinuity in syslog reporting.
	// The field does not have any specific syntax or semantics; the
	// value is implementation-dependent and/or operator-assigned.
	ProcID ProcID

	// MsgID identifies the type of message. Messages with the same
	// MsgID should reflect events with the same semantics. The MSGID
	// itself is a string without further semantics. It is intended
	// for filtering messages on a relay or collector.
	MsgID MsgID
}

type Hostname struct {
	// FQDN is a fully-qualified domain name.
	//
	// See RFC 1034.
	FQDN string

	// StaticIP is a statically-assigned IP address.
	//
	// See RFC 1035 or 4291-2.2.
	StaticIP net.IP

	// Hostname is an unqualified host name.
	Hostname string

	// DyanmicIP is a dynamically-assigned IP address.
	//
	// See RFC 1035 or 4291-2.2.
	DynamicIP net.IP
}

type Message struct {
	Header
	StructuredData

	// Msg is the record's UTF-8 message string.
	Msg string
}

type MsgID string

type Priority struct {
	// Severity is the criticality of the log record.
	Severity Severity

	// Facility is the system component for which the log record
	// was created.
	Facility Facility
}

type ProcID string

type Severity int

type StructuredData []StructuredDataElement

type StructuredDataElement interface {
	// ID returns the "SD-ID" for the element.
	ID() StructuredDataName

	// Params returns all the elements items (if any), in order.
	Params() []StructuredDataParam

	// Validate ensures that the element is correct.
	Validate() error
}

type StructuredDataName string

type StructuredDataParam struct {
	// Name identifies the item relative to an element. Note that an
	// element may have more than one item with the same name.
	Name StructuredDataName

	// Value is the value associated with the item.
	Value StructuredDataParamValue
}

type StructuredDataParamValue string // RFC 3629

type Timestamp struct {
	time.Time
}