/src/logging-log4cxx/src/main/include/log4cxx/helpers/socket.h
Line | Count | Source |
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_HELPERS_SOCKET_H |
19 | | #define _LOG4CXX_HELPERS_SOCKET_H |
20 | | |
21 | | #include <log4cxx/helpers/inetaddress.h> |
22 | | #include <log4cxx/helpers/pool.h> |
23 | | |
24 | | |
25 | | namespace LOG4CXX_NS |
26 | | { |
27 | | namespace helpers |
28 | | { |
29 | | class ByteBuffer; |
30 | | |
31 | | class Socket; |
32 | | LOG4CXX_PTR_DEF(Socket); |
33 | | LOG4CXX_UNIQUE_PTR_DEF(Socket); |
34 | | |
35 | | /** |
36 | | Abstract base class for an outgoing socket connection. |
37 | | A socket is an endpoint for communication between |
38 | | two network connected machines or processes. |
39 | | */ |
40 | | class LOG4CXX_EXPORT Socket : public helpers::Object |
41 | | { |
42 | | protected: |
43 | | LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(SocketPrivate, m_priv) |
44 | | Socket(LOG4CXX_PRIVATE_PTR(SocketPrivate) priv); |
45 | | |
46 | | public: |
47 | | DECLARE_ABSTRACT_LOG4CXX_OBJECT(Socket) |
48 | 0 | BEGIN_LOG4CXX_CAST_MAP() |
49 | 0 | LOG4CXX_CAST_ENTRY(Socket) |
50 | 0 | END_LOG4CXX_CAST_MAP() |
51 | | |
52 | | virtual ~Socket(); |
53 | | |
54 | | virtual size_t write(ByteBuffer&) = 0; |
55 | | |
56 | | #if 15 < LOG4CXX_ABI_VERSION |
57 | | /** |
58 | | Use \c newValue for the behaviour when the network buffer (on an accepted socket connection) is full. |
59 | | |
60 | | When true, an exception is thrown if the write would block. |
61 | | */ |
62 | | virtual void setNonBlocking(bool newValue) = 0; |
63 | | #endif |
64 | | |
65 | | /** Close this socket. */ |
66 | | virtual void close() = 0; |
67 | | |
68 | | /** Returns the value of this socket's address field. */ |
69 | | InetAddressPtr getInetAddress() const; |
70 | | |
71 | | /** Returns the value of this socket's port field. */ |
72 | | int getPort() const; |
73 | | |
74 | | /** Create a concrete instance of this class |
75 | | */ |
76 | | static SocketUniquePtr create(InetAddressPtr& address, int port); |
77 | | |
78 | | private: |
79 | | Socket(const Socket&); |
80 | | Socket& operator=(const Socket&); |
81 | | |
82 | | }; |
83 | | |
84 | | } // namespace helpers |
85 | | } // namespace log4cxx |
86 | | |
87 | | #if 15 < LOG4CXX_ABI_VERSION |
88 | | #define LOG4CXX_16_VIRTUAL_SPECIFIER override |
89 | | #else |
90 | | #define LOG4CXX_16_VIRTUAL_SPECIFIER |
91 | | #endif |
92 | | |
93 | | #endif // _LOG4CXX_HELPERS_SOCKET_H |