Updated footer comment
[yazpp-moved-to-github.git] / include / yazpp / pdu-assoc.h
1 /* This file is part of the yazpp toolkit.
2  * Copyright (C) 1998-2009 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 /** Simple Protocol Data Unit Assocation.
37     This object sends - and receives PDU's using the COMSTACK
38     network utility. To use the association in client role, use
39     the method connect. The server role is initiated by using the
40     listen method.
41  */
42 class YAZ_EXPORT PDU_Assoc : public IPDU_Observable, yazpp_1::ISocketObserver {
43     friend class PDU_AssocThread;
44  private:
45     enum { 
46         Connecting,
47         Listen,
48         Ready,
49         Closed,
50         Writing,
51         Accepting
52     } m_state;
53     class PDU_Queue {
54     public:
55         PDU_Queue(const char *buf, int len);
56         ~PDU_Queue();
57         char *m_buf;
58         int m_len;
59         PDU_Queue *m_next;
60     };
61     PDU_Assoc *m_parent;
62     PDU_Assoc *m_children;
63     PDU_Assoc *m_next;
64     COMSTACK m_cs;
65     yazpp_1::ISocketObservable *m_socketObservable;
66     IPDU_Observer *m_PDU_Observer;
67     char *m_input_buf;
68     int m_input_len;
69     PDU_Queue *m_queue_out;
70     PDU_Queue *m_queue_in;
71     int flush_PDU();
72     int *m_destroyed;
73     int m_idleTime;
74     int m_log;
75     void init(yazpp_1::ISocketObservable *socketObservable);
76     bool m_session_is_dead;
77  public:
78     COMSTACK comstack(const char *type_and_host, void **vp);
79     /// Create object using specified socketObservable
80     PDU_Assoc(yazpp_1::ISocketObservable *socketObservable);
81     /// Create Object using existing comstack
82     PDU_Assoc(yazpp_1::ISocketObservable *socketObservable,
83                   COMSTACK cs);
84     /// Close socket and destroy object.
85     /// virtual ~PDU_Assoc();
86     /// Clone the object
87     IPDU_Observable *clone();
88     /// Send PDU
89     int send_PDU(const char *buf, int len);
90     /// connect to server (client role)
91     int connect(IPDU_Observer *observer, const char *addr);
92     /// listen for clients (server role)
93     int listen(IPDU_Observer *observer, const char *addr);
94     /// Socket notification
95     void socketNotify(int event);
96     /// Close socket
97     void shutdown();
98     /// Close and destroy
99     void destroy();
100     /// Set Idle Time
101     void idleTime (int timeout);
102     /// Child start...
103     virtual void childNotify(COMSTACK cs);
104     /// close session
105     void close_session();
106     const char *getpeername();
107 };
108
109 class YAZ_EXPORT PDU_AssocThread : public PDU_Assoc {
110  public:
111     PDU_AssocThread(yazpp_1::ISocketObservable *socketObservable);
112  private:
113     void childNotify(COMSTACK cs);
114
115 };
116 };
117
118 #endif
119
120 /*
121  * Local variables:
122  * c-basic-offset: 4
123  * c-file-style: "Stroustrup"
124  * indent-tabs-mode: nil
125  * End:
126  * vim: shiftwidth=4 tabstop=8 expandtab
127  */
128