Apache Log4cxx  Version 2.0.0
Loading...
Searching...
No Matches
syslogappender.h
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18#ifndef _LOG4CXX_NET_SYSLOG_APPENDER_H
19#define _LOG4CXX_NET_SYSLOG_APPENDER_H
20
23
24namespace LOG4CXX_NS
25{
26namespace net
27{
56class LOG4CXX_EXPORT SyslogAppender : public AppenderSkeleton
57{
58 public:
64
65
66
68 SyslogAppender(const LayoutPtr& layout, int syslogFacility);
70 const LogString& syslogHost, int syslogFacility);
72
77 static LogString getFacilityString(int syslogFacility);
78
87 static int getFacility(const LogString& facilityName);
88
89 void append( const spi::LoggingEventPtr& event ) override;
90
111 void setOption(const LogString& option, const LogString& value) override;
112
119 void setSyslogHost(const LogString& syslogHost);
120
124 const LogString& getSyslogHost() const;
125
134 void setFacility(const LogString& facilityName);
135
140
146 void setFacilityPrinting(bool facilityPrinting1);
147
152
153 void setMaxMessageLength(int maxMessageLength1);
154
156
165 void setFormat(const LogString& format);
166
172
182 void setAppName(const LogString& appName);
183
187 const LogString& getAppName() const;
188
198 void setMessageId(const LogString& messageId);
199
203 const LogString& getMessageId() const;
204
205 protected:
207
208 private:
209 struct SyslogAppenderPriv;
211 SyslogAppender& operator=(const SyslogAppender&);
212}; // class SyslogAppender
214} // namespace net
215} // namespace log4cxx
216
217#endif // _LOG4CXX_NET_SYSLOG_APPENDER_H
218
AppenderSkeleton(LOG4CXX_PRIVATE_PTR(AppenderSkeletonPrivate) priv)
Use SyslogAppender to send log messages to a remote syslog daemon.
Definition syslogappender.h:57
const LogString & getSyslogHost() const
Returns the value of the SyslogHost option.
void append(const spi::LoggingEventPtr &event) override
Subclasses of AppenderSkeleton must implement this method to perform actual logging.
void setMaxMessageLength(int maxMessageLength1)
void setFormat(const LogString &format)
Set the format of messages sent to a remote syslog daemon.
void setAppName(const LogString &appName)
Set the APP-NAME field of messages in the RFC5424 format.
void setFacility(const LogString &facilityName)
Set the syslog facility.
const LogString & getMessageId() const
Returns the value of the MessageId option.
void setFacilityPrinting(bool facilityPrinting1)
If the FacilityPrinting option is set to true, the printed message will include the facility name of ...
bool getFacilityPrinting() const
Returns the value of the FacilityPrinting option.
const LogString & getAppName() const
Returns the value of the AppName option.
void setOption(const LogString &option, const LogString &value) override
Override this method to set option to value.
void setMessageId(const LogString &messageId)
Set the MSGID field of messages in the RFC5424 format.
void setSyslogHost(const LogString &syslogHost)
The SyslogHost option is the name of the the syslog host where log output should go.
static LogString getFacilityString(int syslogFacility)
Returns the specified syslog facility as a lower-case String, e.g.
static int getFacility(const LogString &facilityName)
Returns the integer value corresponding to the named syslog facility, or -1 if it couldn't be recogni...
LogString getFormat() const
Returns the value of the Format option, either "BSD" or "RFC5424".
LOG4CXX_PTR_DEF(JSONSocketAppender)
Definition appender.h:30
std::basic_string< logchar > LogString
Definition logstring.h:51
std::shared_ptr< Layout > LayoutPtr
Definition appender.h:42
#define LOG4CXX_CAST_ENTRY(Interface)
Definition object.h:153
#define END_LOG4CXX_CAST_MAP()
Definition object.h:147
#define DECLARE_LOG4CXX_OBJECT(object)
Definition object.h:41
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition object.h:159
#define BEGIN_LOG4CXX_CAST_MAP()
Definition object.h:141