cscg24-guacamole

CSCG 2024 Challenge 'Guacamole Mashup'
git clone https://git.sinitax.com/sinitax/cscg24-guacamole
Log | Files | Refs | sfeed.txt

argv-fntypes.h (2020B)

      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_FNTYPES_H
     21#define GUAC_ARGV_FNTYPES_H
     22
     23/**
     24 * Function type definitions related to automatic handling of received "argv"
     25 * instructions.
     26 *
     27 * @file argv-fntypes.h
     28 */
     29
     30#include "user-types.h"
     31
     32/**
     33 * Callback which is invoked by the automatic "argv" handling when the full
     34 * value of a received argument has been received.
     35 *
     36 * @param user
     37 *     The user that opened the argument value stream.
     38 *
     39 * @param mimetype
     40 *     The mimetype of the data that will be sent along the stream.
     41 *
     42 * @param name
     43 *     The name of the connection parameter being updated. It is up to the
     44 *     implementation of this handler to decide whether and how to update a
     45 *     connection parameter.
     46 *
     47 * @param value
     48 *     The value of the received argument.
     49 *
     50 * @param data
     51 *     Any arbitrary data that was provided when the received argument was
     52 *     registered with guac_argv_register().
     53 *
     54 * @return
     55 *     Zero if the received argument value has been accepted and has either
     56 *     taken effect or is being intentionally ignored, non-zero otherwise.
     57 */
     58typedef int guac_argv_callback(guac_user* user, const char* mimetype,
     59        const char* name, const char* value, void* data);
     60
     61#endif
     62