include/afb/afb-arg.h

   1 /*
   2  * Copyright (C) 2015-2020 "IoT.bzh"
   3  * Author: José Bollo <jose.bollo@iot.bzh>
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #pragma once
  19
  20 /** @addtogroup AFB_REQ
  21  *  @{ */
  22
  23 /**
  24  * Describes an argument (or parameter) of a request.
  25  *
  26  * @see afb_req_get
  27  */
  28 struct afb_arg
  29 {
  30         const char *name;       /**< name of the argument or NULL if invalid */
  31         const char *value;      /**< string representation of the value of the argument */
  32                                 /**< original filename of the argument if path != NULL */
  33         const char *path;       /**< if not NULL, path of the received file for the argument */
  34                                 /**< when the request is finalized this file is removed */
  35 };
  36
  37
  38 /** @} */