Builder class for GelfMessage instances. More...

#include <GelfMessageBuilder.hpp>

Public Member Functions
GelfMessageBuilder &	operator() (const std::string &message)
	Sets the short_message field. More...

template<typename T >
GelfMessageBuilder &	operator() (const std::string &field, T value)
	Sets a field to the given value. More...

template<typename Decorator >
GelfMessageBuilder &	operator() (Decorator decorator)
	Applies a decorator to the message. More...

Detailed Description

Builder class for GelfMessage instances.

Allows convenient construction for GelfMessages with additional Decorator support. The builder is implicitly convertible to a GelfMessage and can be directly passed to an Output.

Note: The internal GelfMessage is not copy-constructible, thus
GelfMessage msg = builder;
is invalid! But move-construction from an temporary GelfMessageBuilder is allowed.

Example usage:

GelfMessageBuilder builder;
builder("This is the short_message");
builder("field_1", true)("field_2", "chains are possible too!");
output->Write(builder);

Decorators are also supported. A decorator is a functional having the following syntax:

void operator()(GelfMessage& message)

This allows to dynamically set common values via a globally defined decorator. Common use cases are e.g. adding the current timestamp, setting the "host" field.

Example useage:

auto add_common_fields = [](GelfMessage& message)
{
    message.SetTimestamp(std::time(nullptr));
    message.SetHost("my-host");
};
builder(add_common_fields);

Member Function Documentation

GelfMessageBuilder& gelfcpp::GelfMessageBuilder::operator() ( const std::string & message )

inline

Sets the short_message field.

Equivalent to gelf_message.SetMessage(message).

Parameters

message message

Returns: *this , for chaining

See also: GelfMessage::SetMessage()

template<typename T >

GelfMessageBuilder& gelfcpp::GelfMessageBuilder::operator()	(	const std::string &	field,
		T	value
	)

inline

Sets a field to the given value.

Equivalent to gelf_message.SetField(field, value).

Template Parameters

T	any supported field type,

See also: GelfMessage::SetField()

Parameters

field	field name
value	field value

Returns: *this , for chaining

See also: GelfMessage::SetField()

template<typename Decorator >

GelfMessageBuilder& gelfcpp::GelfMessageBuilder::operator() ( Decorator decorator )

inline

Applies a decorator to the message.

Equivalent to decorator(gelf_message).

Template Parameters

Decorator decorator type

Parameters

decorator decorator function

Returns: *this , for chaining

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

include/gelfcpp/GelfMessageBuilder.hpp

Public Member Functions

Detailed Description

Member Function Documentation