Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
unix.h
Go to the documentation of this file.
1 // Copyright (C) 1999-2005 Open Source Telecom Corporation.
2 // Copyright (C) 2006-2010 David Sugar, Tycho Softworks.
3 //
4 // This program is free software; you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation; either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 //
18 // As a special exception, you may use this file as part of a free software
19 // library without restriction. Specifically, if other files instantiate
20 // templates or use macros or inline functions from this file, or you compile
21 // this file and link it with other files to produce an executable, this
22 // file does not by itself cause the resulting executable to be covered by
23 // the GNU General Public License. This exception does not however
24 // invalidate any other reasons why the executable file might be covered by
25 // the GNU General Public License.
26 //
27 // This exception applies only to the code released under the name GNU
28 // Common C++. If you copy code from other releases into a copy of GNU
29 // Common C++, as the General Public License permits, the exception does
30 // not apply to the code that you add in this way. To avoid misleading
31 // anyone as to the status of such modified files, you must delete
32 // this exception notice from them.
33 //
34 // If you write modifications of your own for GNU Common C++, it is your choice
35 // whether to permit this exception to apply to your modifications.
36 // If you do not wish that, delete this exception notice.
37 //
38 
44 #ifndef CCXX_UNIX_H_
45 #define CCXX_UNIX_H_
46 
47 #ifndef CCXX_MISSING_H_
48 #include <cc++/missing.h>
49 #endif
50 
51 #ifndef CCXX_SOCKET_H_
52 #include <cc++/socket.h>
53 #endif
54 
55 #ifdef CCXX_NAMESPACES
56 namespace ost {
57 #endif
58 
59 #ifndef WIN32
60 
74  class UnixSocket : protected Socket {
75  protected:
76  friend class UnixStream;
77  friend class SocketPort;
78  friend class unixstream;
79 
80  void close(void);
81  char *path;
82 
83  public:
92  UnixSocket(const char* pathname, int backlog = 5);
93 
99 
103  virtual ~UnixSocket();
104  };
105 
119  class UnixStream : public Socket, public std::streambuf, public std::iostream {
120  private:
121  int doallocate();
122 
123  protected:
125  int bufsize;
126  char *gbuf, *pbuf;
127 
132  UnixStream(bool throwflag = true);
133 
140  void allocate(int size);
141 
146  void endStream(void);
147 
154  virtual int underflow(void);
155 
164  int uflow(void);
165 
173  int overflow(int ch);
174 
181  void connect(const char* pathname, int size);
182 
190  std::iostream *unixstr(void)
191  {return ((std::iostream *)this);};
192 
193  public:
204  UnixStream(UnixSocket &server, int size = 512, bool throwflag = true, timeout_t timeout = 0);
205 
214  UnixStream(const char* pathname, int size = 512, bool throwflag = true, timeout_t to = 0);
215 
221  inline void setTimeout(timeout_t to)
222  {timeout = to;};
223 
230  UnixStream(const UnixStream &source);
231 
236  virtual ~UnixStream();
237 
244  int sync(void);
245 
253  bool isPending(Pending pend, timeout_t timeout = TIMEOUT_INF);
254 
260  int getBufferSize(void) const
261  {return bufsize;};
262  };
263 
272  class unixstream : public UnixStream {
273  public:
277  unixstream();
278 
286  unixstream(const char *pathname, int buffer = 512);
287 
295  unixstream(UnixSocket &unixsock, int buffer = 512);
296 
304  void open(const char *pathname, int buffer = 512)
305  {UnixStream::connect( pathname, buffer );}
306 
313  void open(UnixSocket &unixsock, int buffer = 512);
314 
318  void close(void);
319 
323  bool operator!() const;
324  };
325 
336  class __EXPORT UnixSession : public Thread, public UnixStream {
337  protected:
350  int waitConnection(timeout_t timeout = TIMEOUT_INF);
351 
358  void initial(void);
359 
360  public:
370  UnixSession(const char* pathname, int size = 512, int pri = 0, int stack = 0);
371 
381  UnixSession(UnixSocket &server, int size = 512,
382  int pri = 0, int stack = 0);
383 
387  virtual ~UnixSession();
388  };
389 
390 #endif // ndef WIN32
391 
392 #ifdef CCXX_NAMESPACES
393 }
394 #endif
395 
396 #endif
397 
398 
399 
virtual bool isPending(Pending pend, timeout_t timeout=TIMEOUT_INF)
Get the status of pending operations.
The Socket is used as the base for all Internet protocol services under Common C++.
Definition: socket.h:119
char * pbuf
Definition: unix.h:126
int getBufferSize(void) const
Return the size of the current stream buffering used.
Definition: unix.h:260
void close(void)
Close the active tcp stream connection.
void setTimeout(timeout_t to)
Set the I/O operation timeout for socket I/O operations.
Definition: unix.h:221
substitute functions which may be missing in target platform libc.
#define TIMEOUT_INF
Definition: thread.h:115
Unix domain sockets are used for stream based connected sessions between processes on the same machin...
Definition: unix.h:74
unsigned long timeout_t
Definition: thread.h:74
int bufsize
Definition: unix.h:125
Unix streams are used to represent Unix domain client connections to a local server for accepting cli...
Definition: unix.h:119
timeout_t timeout
Definition: unix.h:124
The socket port is an internal class which is attached to and then serviced by a specific SocketServi...
Definition: socketport.h:81
bool isPendingConnection(timeout_t timeout=TIMEOUT_INF)
Used to wait for pending connection requests.
Definition: unix.h:97
#define __EXPORT
Definition: audio2.h:51
The Unix domain session is used to primarily to represent a client connection that can be managed on ...
Definition: unix.h:336
Every thread of execution in an application is created by instantiating an object of a class derived ...
Definition: thread.h:1093
void connect(const char *pathname, int size)
Create a Unix domain stream by connecting to a Unix domain socket.
A more natural C++ "unixstream" class for use by non-threaded applications.
Definition: unix.h:272
std::iostream * unixstr(void)
Used in derived classes to refer to the current object via it's iostream.
Definition: unix.h:190
void open(const char *pathname, int buffer=512)
Open a tcp stream connection.
Definition: unix.h:304
Network addresses and sockets related classes.
char * path
Definition: unix.h:81