summaryrefslogtreecommitdiff
path: root/source4/libcli/composite/composite.h
diff options
context:
space:
mode:
Diffstat (limited to 'source4/libcli/composite/composite.h')
-rw-r--r--source4/libcli/composite/composite.h72
1 files changed, 72 insertions, 0 deletions
diff --git a/source4/libcli/composite/composite.h b/source4/libcli/composite/composite.h
new file mode 100644
index 0000000000..895c88a4f6
--- /dev/null
+++ b/source4/libcli/composite/composite.h
@@ -0,0 +1,72 @@
+/*
+ Unix SMB/CIFS implementation.
+
+ SMB composite request interfaces
+
+ Copyright (C) Andrew Tridgell 2005
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/*
+ this defines the structures associated with "composite"
+ requests. Composite requests are libcli requests that are internally
+ implemented as multiple libcli/raw/ calls, but can be treated as a
+ single call via these composite calls. The composite calls are
+ particularly designed to be used in async applications
+*/
+
+
+struct smbcli_composite {
+ /* the external state - will be queried by the caller */
+ enum smbcli_request_state state;
+
+ /* the internal stage */
+ uint16_t stage;
+
+ /* the currently running sub-request */
+ struct smbcli_request *req;
+
+ /* the current requests parameter block */
+ void *req_parms;
+
+ /* the parameters of the whole composite function */
+ void *composite_parms;
+
+ /* status code when finished */
+ NTSTATUS status;
+
+ /* information on what to do on completion */
+ struct {
+ void (*fn)(struct smbcli_composite *);
+ void *private;
+ } async;
+
+};
+
+
+/*
+ a composite open/read(s)/close request that loads a whole file
+ into memory. Used as a demo of the composite system.
+*/
+struct smb_composite_loadfile {
+ struct {
+ const char *fname;
+ } in;
+ struct {
+ uint8_t *data;
+ uint32_t size;
+ } out;
+};