source: vscpl/src/hu/varadiistvan/scpl/io/LocalClientSocket.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.4 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_LOCALCLIENTSOCKET_H
30#define HU_VARADIISTVAN_SCPL_IO_LOCALCLIENTSOCKET_H
31//------------------------------------------------------------------------------
32
33#if 0 // The public interface of LocalClientSocket
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl { namespace io {
38
39//------------------------------------------------------------------------------
40
41class LocalConnector;
42
43//------------------------------------------------------------------------------
44
45/**
46 * Client socket that connects to a server socket locally. On Linux it
47 * is a Unix socket, on Windows it is a named pipe.
48 *
49 * The server socket's name should be given.
50 */
51class LocalClientSocket : public BufferedStream
52{
53public:
54 /**
55 * Construct the client socket with the given name.
56 *
57 * @param name the name of the server 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 connect()
61 * function of the Connector might block as well as the reading
62 * and writing buffers.
63 * @param readingCapacity the capacity of the reading buffer
64 * @param writingCapacity the capacity of the writing buffer
65 */
66 LocalClientSocket(const char* name, Waiter* waiter = 0,
67 size_t readingCapacity = DEFAULT_CAPACITY,
68 size_t writingCapacity = DEFAULT_CAPACITY);
69
70 /**
71 * Get the connector. Use this object to connect to another socket.
72 */
73 LocalConnector& getConnector();
74};
75
76//------------------------------------------------------------------------------
77
78} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
79
80//------------------------------------------------------------------------------
81
82#endif // 0, The public interface of LocalClientSocket
83
84//------------------------------------------------------------------------------
85
86#include "hu/varadiistvan/scpl/config.h"
87
88//------------------------------------------------------------------------------
89
90#if TARGET_API_POSIX
91
92#include "_posix/LocalClientSocket.h"
93
94//------------------------------------------------------------------------------
95
96#elif TARGET_API_WIN32 || TARGET_API_WIN64
97
98#include "_win32/LocalClientSocket.h"
99
100//------------------------------------------------------------------------------
101
102#else
103
104#error "Not implemented for this target!"
105
106#endif
107
108//------------------------------------------------------------------------------
109#endif // HU_VARADIISTVAN_SCPL_LOCALCLIENTSOCKET_H
110
111// Local Variables:
112// mode: C++
113// c-basic-offset: 4
114// indent-tabs-mode: nil
115// End:
Note: See TracBrowser for help on using the repository browser.