Remove redundant comment
[yazpp-moved-to-github.git] / include / yazpp / pdu-assoc.h
1 /* This file is part of the yazpp toolkit.
2  * Copyright (C) 1998-2012 Index Data and Mike Taylor
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #ifndef YAZ_PDU_ASSOC_INCLUDED
29 #define YAZ_PDU_ASSOC_INCLUDED
30
31 #include <yaz/comstack.h>
32 #include <yazpp/socket-observer.h>
33 #include <yazpp/pdu-observer.h>
34
35 namespace yazpp_1 {
36     class PDU_Assoc_priv;
37
38 /** Simple Protocol Data Unit Assocation.
39     This object sends - and receives PDU's using the COMSTACK
40     network utility. To use the association in client role, use
41     the method connect. The server role is initiated by using the
42     listen method.
43  */
44 class YAZ_EXPORT PDU_Assoc : public IPDU_Observable, yazpp_1::ISocketObserver {
45     friend class PDU_AssocThread;
46     PDU_Assoc_priv *m_p;
47     IPDU_Observer *m_PDU_Observer;
48
49     int flush_PDU();
50     COMSTACK comstack(const char *type_and_host, void **vp);
51  public:
52     /// Create object using specified socketObservable
53     PDU_Assoc(yazpp_1::ISocketObservable *socketObservable);
54     /// Create Object using existing comstack
55     PDU_Assoc(yazpp_1::ISocketObservable *socketObservable,
56               COMSTACK cs);
57     /// virtual ~PDU_Assoc();
58     virtual ~PDU_Assoc();
59     /// Clone the object
60     IPDU_Observable *clone();
61     /// Send PDU
62     int send_PDU(const char *buf, int len);
63     /// connect to server (client role)
64     int connect(IPDU_Observer *observer, const char *addr);
65     /// listen for clients (server role)
66     int listen(IPDU_Observer *observer, const char *addr);
67     /// Socket notification
68     void socketNotify(int event);
69     /// Close socket
70     void shutdown();
71     /// Close and destroy
72     void destroy();
73     /// Set Idle Time
74     void idleTime(int timeout);
75     /// Child start...
76     virtual void childNotify(COMSTACK cs);
77     /// close session
78     void close_session();
79     const char *getpeername();
80 };
81
82 class YAZ_EXPORT PDU_AssocThread : public PDU_Assoc {
83  public:
84     PDU_AssocThread(yazpp_1::ISocketObservable *socketObservable);
85  private:
86     void childNotify(COMSTACK cs);
87
88 };
89 };
90
91 #endif
92
93 /*
94  * Local variables:
95  * c-basic-offset: 4
96  * c-file-style: "Stroustrup"
97  * indent-tabs-mode: nil
98  * End:
99  * vim: shiftwidth=4 tabstop=8 expandtab
100  */
101