1/*
2 * Copyright (c) 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of its
16 *     contributors may be used to endorse or promote products derived from
17 *     this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Portions of this software have been released under the following terms:
31 *
32 * (c) Copyright 1989-1993 OPEN SOFTWARE FOUNDATION, INC.
33 * (c) Copyright 1989-1993 HEWLETT-PACKARD COMPANY
34 * (c) Copyright 1989-1993 DIGITAL EQUIPMENT CORPORATION
35 *
36 * To anyone who acknowledges that this file is provided "AS IS"
37 * without any express or implied warranty:
38 * permission to use, copy, modify, and distribute this file for any
39 * purpose is hereby granted without fee, provided that the above
40 * copyright notices and this notice appears in all source code copies,
41 * and that none of the names of Open Software Foundation, Inc., Hewlett-
42 * Packard Company or Digital Equipment Corporation be used
43 * in advertising or publicity pertaining to distribution of the software
44 * without specific, written prior permission.  Neither Open Software
45 * Foundation, Inc., Hewlett-Packard Company nor Digital
46 * Equipment Corporation makes any representations about the suitability
47 * of this software for any purpose.
48 *
49 * Copyright (c) 2007, Novell, Inc. All rights reserved.
50 * Redistribution and use in source and binary forms, with or without
51 * modification, are permitted provided that the following conditions
52 * are met:
53 *
54 * 1.  Redistributions of source code must retain the above copyright
55 *     notice, this list of conditions and the following disclaimer.
56 * 2.  Redistributions in binary form must reproduce the above copyright
57 *     notice, this list of conditions and the following disclaimer in the
58 *     documentation and/or other materials provided with the distribution.
59 * 3.  Neither the name of Novell Inc. nor the names of its contributors
60 *     may be used to endorse or promote products derived from this
61 *     this software without specific prior written permission.
62 *
63 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
64 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
65 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
66 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
69 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
70 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
72 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73 *
74 * @APPLE_LICENSE_HEADER_END@
75 */
76
77/*
78**
79**  NAME:
80**
81**      dgccall.h
82**
83**  FACILITY:
84**
85**      Remote Procedure Call (RPC)
86**
87**  ABSTRACT:
88**
89**  DG protocol service routines
90**
91**
92*/
93
94#ifndef _DGCCALL_H
95#define _DGCCALL_H	1
96
97#include <dgccallt.h>
98
99/*
100 * R P C _ D G _ C C A L L _ S E T _ S T A T E _ I D L E
101 *
102 * Remove the call handle from the CCALLT.  Release our reference to
103 * our CCTE.  (In the case of CCALLs created to do server callbacks there
104 * won't be a ccte_ref.)  Change to the idle state.  If you're trying
105 * to get rid of the ccall use rpc__dg_ccall_free_prep() instead.
106 */
107
108#define RPC_DG_CCALL_SET_STATE_IDLE(ccall) { \
109    if ((ccall)->c.state == rpc_e_dg_cs_final) \
110        rpc__dg_ccall_ack(ccall); \
111    rpc__dg_ccallt_remove(ccall); \
112    if (! (ccall)->c.is_cbk)\
113        RPC_DG_CCT_RELEASE(&(ccall)->ccte_ref); \
114    RPC_DG_CALL_SET_STATE(&(ccall)->c, rpc_e_dg_cs_idle); \
115}
116
117/*
118 * R P C _ D G _ C C A L L _ R E L E A S E
119 *
120 * Decrement the reference count for the CCALL and
121 * NULL the reference.
122 */
123
124#define RPC_DG_CCALL_RELEASE(ccall) { \
125    RPC_DG_CALL_LOCK_ASSERT(&(*(ccall))->c); \
126    assert((*(ccall))->c.refcnt > 0); \
127    if (--(*(ccall))->c.refcnt == 0) \
128        rpc__dg_ccall_free(*(ccall)); \
129    else \
130        RPC_DG_CALL_UNLOCK(&(*(ccall))->c); \
131    *(ccall) = NULL; \
132}
133
134/*
135 * R P C _ D G _ C C A L L _ R E L E A S E _ N O _ U N L O C K
136 *
137 * Like RPC_DG_CCALL_RELEASE, except doesn't unlock the CCALL.  Note
138 * that the referencing counting model requires that this macro can be
139 * used iff the release will not be the "last one" (i.e., the one that
140 * would normally cause the CCALL to be freed).
141 */
142
143#define RPC_DG_CCALL_RELEASE_NO_UNLOCK(ccall) { \
144    RPC_DG_CALL_LOCK_ASSERT(&(*(ccall))->c); \
145    assert((*(ccall))->c.refcnt > 1); \
146    --(*(ccall))->c.refcnt; \
147    *(ccall) = NULL; \
148}
149
150#ifdef __cplusplus
151extern "C" {
152#endif
153
154PRIVATE void rpc__dg_ccall_lsct_inq_scall (
155        rpc_dg_ccall_p_t  /*ccall*/,
156        rpc_dg_scall_p_t * /*scallp*/
157    );
158
159PRIVATE void rpc__dg_ccall_lsct_new_call (
160        rpc_dg_ccall_p_t  /*ccall*/,
161        rpc_dg_sock_pool_elt_p_t  /*si*/,
162        rpc_dg_recvq_elt_p_t  /*rqe*/,
163        rpc_dg_scall_p_t * /*scallp*/
164    );
165
166PRIVATE void rpc__dg_ccall_ack (
167        rpc_dg_ccall_p_t /*ccall*/
168    );
169
170PRIVATE void rpc__dg_ccall_free (
171        rpc_dg_ccall_p_t /*ccall*/
172    );
173
174PRIVATE void rpc__dg_ccall_free_prep (
175        rpc_dg_ccall_p_t /*ccall*/
176    );
177
178PRIVATE void rpc__dg_ccall_timer ( dce_pointer_t /*p*/ );
179
180PRIVATE void rpc__dg_ccall_xmit_cancel_quit (
181        rpc_dg_ccall_p_t  /*ccall*/,
182        unsigned32 /*cancel_id*/
183    );
184
185PRIVATE void rpc__dg_ccall_setup_cancel_tmo (
186        rpc_dg_ccall_p_t /*ccall*/
187    );
188
189#ifdef __cplusplus
190}
191#endif
192
193#endif /* _DGCCALL_H */
194