source: vscpl/src/hu/varadiistvan/scpl/io/LocalServerSocket.h@ 27:3c2f8c4beb2c

Last change on this file since 27:3c2f8c4beb2c was 16:e0caabe4ca3b, checked in by István Váradi <ivaradi@…>, 12 years ago

Added basic documentation

File size: 4.1 KB
Line 
1// Copyright (c) 2013 by István Váradi
2
3// This file is part of VSCPL, a simple cross-platform utility library
4
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are met:
7
8// 1. Redistributions of source code must retain the above copyright notice, this
9// list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright notice,
11// this list of conditions and the following disclaimer in the documentation
12// and/or other materials provided with the distribution.
13
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24
25// The views and conclusions contained in the software and documentation are those
26// of the authors and should not be interpreted as representing official policies,
27// either expressed or implied, of the FreeBSD Project.
28
29#ifndef HU_VARADIISTVAN_SCPL_IO_LOCALSERVERSOCKET_H
30#define HU_VARADIISTVAN_SCPL_IO_LOCALSERVERSOCKET_H
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of LocalServerSocket
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41/**
42 * A server socket that provides a local, named access point. On
43 * Linux, it is a Unix socket, on Windows it is a named pipe.
44 *
45 * It is identified by a name that should be unique for the user.
46 */
47class LocalServerSocket
48{
49public:
50 /**
51 * Construct the socket with the given name.
52 *
53 * It will be bound to the name and able to listen for incoming
54 * connections.
55 *
56 * @param name the name of the server socket that can be used by
57 * clients to connect to this socket
58 * @param waiter the waiter to use for waiting a possible event
59 * occuring on the socket. If given, the socket will be
60 * non-blocking. Otherwise, it will be blocking, and the accept()
61 * function of the Acceptor might block.
62 */
63 LocalServerSocket(const char* name, Waiter* waiter = 0);
64
65 /**
66 * Get the acceptor.
67 */
68 LocalAcceptor& getAcceptor();
69};
70
71//------------------------------------------------------------------------------
72
73} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
74
75//------------------------------------------------------------------------------
76
77#endif // 0, The public interface of LocalServerSocket
78
79//------------------------------------------------------------------------------
80
81#include "hu/varadiistvan/scpl/config.h"
82
83//------------------------------------------------------------------------------
84
85#if TARGET_API_POSIX
86
87#include "_posix/LocalServerSocket.h"
88
89//------------------------------------------------------------------------------
90
91#elif TARGET_API_WIN32 || TARGET_API_WIN64
92
93#include "_win32/LocalServerSocket.h"
94
95//------------------------------------------------------------------------------
96
97#else
98
99#error "Not implemented for this target!"
100
101#endif
102
103//------------------------------------------------------------------------------
104#endif // HU_VARADIISTVAN_SCPL_LOCALSERVERSOCKET_H
105
106// Local Variables:
107// mode: C++
108// c-basic-offset: 4
109// indent-tabs-mode: nil
110// End:
Note: See TracBrowser for help on using the repository browser.