libguac 1.6.0
Loading...
Searching...
No Matches
argv.h
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20#ifndef GUAC_ARGV_H
21#define GUAC_ARGV_H
22
29
30#include "argv-constants.h"
31#include "argv-fntypes.h"
32#include "stream-types.h"
33#include "user-fntypes.h"
34
67int guac_argv_register(const char* name, guac_argv_callback* callback, void* data, int options);
68
83int guac_argv_await(const char** args);
84
110int guac_argv_received(guac_stream* stream, const char* mimetype, const char* name);
111
117void guac_argv_stop();
118
125guac_user_argv_handler guac_argv_handler;
126
127#endif
128
argv-constants.h
Constants related to automatic handling of received "argv" instructions.
argv-fntypes.h
Function type definitions related to automatic handling of received "argv" instructions.
guac_argv_callback
int guac_argv_callback(guac_user *user, const char *mimetype, const char *name, const char *value, void *data)
Callback which is invoked by the automatic "argv" handling when the full value of a received argument...
Definition argv-fntypes.h:58
guac_argv_await
int guac_argv_await(const char **args)
Waits for receipt of each of the given arguments via guac_argv_received().
guac_argv_stop
void guac_argv_stop()
Stops further automatic processing of received "argv" streams.
guac_argv_handler
guac_user_argv_handler guac_argv_handler
Convenience implementation of the "argv" instruction handler which automatically sends any required "...
Definition argv.h:125
guac_argv_register
int guac_argv_register(const char *name, guac_argv_callback *callback, void *data, int options)
Registers the given callback such that it is automatically invoked when an "argv" stream for an argum...
guac_argv_received
int guac_argv_received(guac_stream *stream, const char *mimetype, const char *name)
Hands off management of the given guac_stream, automatically processing data received over that strea...
stream-types.h
Type definitions related to Guacamole protocol streams.
guac_stream
Represents a single stream within the Guacamole protocol.
Definition stream.h:32
user-fntypes.h
Function type definitions related to the guac_user object.
guac_user_argv_handler
int guac_user_argv_handler(guac_user *user, guac_stream *stream, char *mimetype, char *name)
Handler for Guacamole argument value (argv) streams received from a user.
Definition user-fntypes.h:312