Apache Log4cxx  Version 1.3.1
telnetappender.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_TELNET_APPENDER_H
19 #define _LOG4CXX_NET_TELNET_APPENDER_H
20 
22 #include <log4cxx/helpers/socket.h>
23 
24 namespace LOG4CXX_NS
25 {
26 namespace helpers
27 {
28 class ByteBuffer;
29 }
30 namespace net
31 {
32 
48 class LOG4CXX_EXPORT TelnetAppender : public AppenderSkeleton
49 {
50  private:
51  static const int DEFAULT_PORT;
52  static const int MAX_CONNECTIONS;
53 
54  public:
60 
63 
67  bool requiresLayout() const override;
68 
74  LogString getEncoding() const;
80  void setEncoding(const LogString& value);
81 
82 
88  void activateOptions(helpers::Pool& p) override;
89 
90 
102  void setOption(const LogString& option, const LogString& value) override;
103 
107  int getPort() const;
108 
112  void setPort(int newValue);
113 
119  int getMaxConnections() const;
120 
126  void setMaxConnections(int newValue);
127 
128 
130  void close() override;
131 
132  protected:
135  void append(const spi::LoggingEventPtr& event, helpers::Pool& p) override;
136 
137  private:
138  // prevent copy and assignment statements
140  TelnetAppender& operator=(const TelnetAppender&);
141 
142  void write(helpers::ByteBuffer&);
143  void writeStatus(const helpers::SocketPtr& socket, const LogString& msg, helpers::Pool& p);
144  void acceptConnections();
145 
146  struct TelnetAppenderPriv;
147 }; // class TelnetAppender
148 
150 } // namespace net
151 } // namespace log4cxx
152 
153 #endif // _LOG4CXX_NET_TELNET_APPENDER_H
154 
Implementation base class for all appenders.
Definition: appenderskeleton.h:41
The TelnetAppender writes log messages to clients that connect to the TCP port.
Definition: telnetappender.h:49
LOG4CXX_PTR_DEF(TelnetAppender)
std::shared_ptr< LoggingEvent > LoggingEventPtr
Definition: appender.h:31
std::basic_string< logchar > LogString
Definition: logstring.h:60
#define LOG4CXX_CAST_ENTRY(Interface)
Definition: object.h:158
#define END_LOG4CXX_CAST_MAP()
Definition: object.h:152
#define DECLARE_LOG4CXX_OBJECT(object)
Definition: object.h:43
#define LOG4CXX_CAST_ENTRY_CHAIN(Interface)
Definition: object.h:164
#define BEGIN_LOG4CXX_CAST_MAP()
Definition: object.h:146