ReactOS  0.4.14-dev-376-gaedba84
rpc_async.c
Go to the documentation of this file.
1 /*
2  * Asynchronous Call Support Functions
3  *
4  * Copyright 2007 Robert Shearman (for CodeWeavers)
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  *
20  */
21 
22 #include <stdarg.h>
23 
24 #include "rpc.h"
25 #include "rpcndr.h"
26 #include "rpcasync.h"
27 
28 #include "wine/debug.h"
29 
30 #include "rpc_binding.h"
31 #include "rpc_message.h"
32 #include "ndr_stubless.h"
33 
35 
36 #define RPC_ASYNC_SIGNATURE 0x43595341
37 
39 {
40  return pAsync->Signature == RPC_ASYNC_SIGNATURE;
41 }
42 
43 /***********************************************************************
44  * RpcAsyncInitializeHandle [RPCRT4.@]
45  *
46  * Initialises an asynchronous state so it can be used in other asynchronous
47  * functions and for use in asynchronous calls.
48  *
49  * PARAMS
50  * pAsync [I] Asynchronous state to initialise.
51  * Size [I] Size of the memory pointed to by pAsync.
52  *
53  * RETURNS
54  * Success: RPC_S_OK.
55  * Failure: Any error code.
56  */
58 {
59  TRACE("(%p, %d)\n", pAsync, Size);
60 
61  if (Size != sizeof(*pAsync))
62  {
63  ERR("invalid Size %d\n", Size);
65  }
66 
67  pAsync->Size = sizeof(*pAsync);
69  pAsync->Lock = 0;
70  pAsync->Flags = 0;
71  pAsync->StubInfo = NULL;
72  pAsync->RuntimeInfo = NULL;
73  memset(pAsync->Reserved, 0, sizeof(*pAsync) - FIELD_OFFSET(RPC_ASYNC_STATE, Reserved));
74 
75  return RPC_S_OK;
76 }
77 
78 /***********************************************************************
79  * RpcAsyncGetCallStatus [RPCRT4.@]
80  *
81  * Retrieves the current status of the asynchronous call taking place.
82  *
83  * PARAMS
84  * pAsync [I] Asynchronous state to initialise.
85  *
86  * RETURNS
87  * RPC_S_OK - The call was successfully completed.
88  * RPC_S_INVALID_ASYNC_HANDLE - The asynchronous structure is not valid.
89  * RPC_S_ASYNC_CALL_PENDING - The call is still in progress and has not been completed.
90  * Any other error code - The call failed.
91  */
93 {
94  FIXME("(%p): stub\n", pAsync);
96 }
97 
98 /***********************************************************************
99  * RpcAsyncCompleteCall [RPCRT4.@]
100  *
101  * Completes a client or server asynchronous call.
102  *
103  * PARAMS
104  * pAsync [I] Asynchronous state to initialise.
105  * Reply [I] The return value of the asynchronous function.
106  *
107  * RETURNS
108  * Success: RPC_S_OK.
109  * Failure: Any error code.
110  */
112 {
113  TRACE("(%p, %p)\n", pAsync, Reply);
114 
115  if (!valid_async_handle(pAsync))
117 
118  /* FIXME: check completed */
119 
120  return NdrpCompleteAsyncClientCall(pAsync, Reply);
121 }
122 
123 /***********************************************************************
124  * RpcAsyncAbortCall [RPCRT4.@]
125  *
126  * Aborts the asynchronous server call taking place.
127  *
128  * PARAMS
129  * pAsync [I] Asynchronous server state to abort.
130  * ExceptionCode [I] Exception code to return to the client in a fault packet.
131  *
132  * RETURNS
133  * Success: RPC_S_OK.
134  * Failure: Any error code.
135  */
137 {
138  FIXME("(%p, %d/0x%x): stub\n", pAsync, ExceptionCode, ExceptionCode);
140 }
141 
142 /***********************************************************************
143  * RpcAsyncCancelCall [RPCRT4.@]
144  *
145  * Cancels the asynchronous client call taking place.
146  *
147  * PARAMS
148  * pAsync [I] Asynchronous client state to abort.
149  * fAbortCall [I] If TRUE, then send a cancel to the server, otherwise
150  * just wait for the call to complete.
151  *
152  * RETURNS
153  * Success: RPC_S_OK.
154  * Failure: Any error code.
155  */
157 {
158  FIXME("(%p, %s): stub\n", pAsync, fAbortCall ? "TRUE" : "FALSE");
160 }
#define ERROR_INVALID_PARAMETER
Definition: compat.h:91
_Inout_ PIRP _In_ NTSTATUS ExceptionCode
Definition: cdprocs.h:1782
RPC_STATUS WINAPI RpcAsyncGetCallStatus(PRPC_ASYNC_STATE pAsync)
Definition: rpc_async.c:92
#define RPC_ASYNC_SIGNATURE
Definition: rpc_async.c:36
LONG_PTR Reserved[4]
Definition: rpcasync.h:156
RPC_STATUS NdrpCompleteAsyncClientCall(RPC_ASYNC_STATE *pAsync, void *Reply)
void * RuntimeInfo
Definition: rpcasync.h:152
RPC_STATUS WINAPI RpcAsyncAbortCall(PRPC_ASYNC_STATE pAsync, ULONG ExceptionCode)
Definition: rpc_async.c:136
long RPC_STATUS
Definition: rpc.h:52
RPC_STATUS WINAPI RpcAsyncInitializeHandle(PRPC_ASYNC_STATE pAsync, unsigned int Size)
Definition: rpc_async.c:57
void * StubInfo
Definition: rpcasync.h:150
unsigned int BOOL
Definition: ntddk_ex.h:94
#define FIXME(fmt,...)
Definition: debug.h:110
smooth NULL
Definition: ftsmooth.c:416
WINE_DEFAULT_DEBUG_CHANNEL(rpc)
_Reserved_ PVOID Reserved
Definition: winddi.h:3974
#define TRACE(s)
Definition: solgame.cpp:4
unsigned int Size
Definition: rpcasync.h:146
#define WINAPI
Definition: msvc.h:8
RPC_STATUS WINAPI RpcAsyncCancelCall(PRPC_ASYNC_STATE pAsync, BOOL fAbortCall)
Definition: rpc_async.c:156
IN PVOID IN PVOID IN USHORT IN USHORT Size
Definition: pci.h:359
#define ERR(fmt,...)
Definition: debug.h:109
#define FIELD_OFFSET(t, f)
Definition: typedefs.h:254
unsigned int ULONG
Definition: retypes.h:1
RPC_STATUS WINAPI RpcAsyncCompleteCall(PRPC_ASYNC_STATE pAsync, void *Reply)
Definition: rpc_async.c:111
#define memset(x, y, z)
Definition: compat.h:39
#define RPC_S_INVALID_ASYNC_HANDLE
Definition: winerror.h:1156
#define RPC_S_OK
Definition: rpcnterr.h:22
static BOOL valid_async_handle(PRPC_ASYNC_STATE pAsync)
Definition: rpc_async.c:38