Blame view

3rdparty/rabbitmq-c-0.11.0/librabbitmq/amqp_table.h 3.16 KB
09c2d08c   Hu Chunming   arm交付版
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
  /*
   * ***** BEGIN LICENSE BLOCK *****
   * Version: MIT
   *
   * Portions created by Alan Antonuk are Copyright (c) 2014 Alan Antonuk.
   * All Rights Reserved.
   *
   * Permission is hereby granted, free of charge, to any person
   * obtaining a copy of this software and associated documentation
   * files (the "Software"), to deal in the Software without
   * restriction, including without limitation the rights to use, copy,
   * modify, merge, publish, distribute, sublicense, and/or sell copies
   * of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be
   * included in all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
   * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
   * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
   * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
   * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   * SOFTWARE.
   * ***** END LICENSE BLOCK *****
   */
  #ifndef AMQP_TABLE_H
  #define AMQP_TABLE_H
  
  #include "amqp.h"
  #include "amqp_private.h"
  
  /**
   * Initializes a table entry with utf-8 string type value.
   *
   * \param [in] key the table entry key. The string must remain valid for the
   * life of the resulting amqp_table_entry_t.
   * \param [in] value the string value. The string must remain valid for the life
   * of the resulting amqp_table_entry_t.
   * \returns An initialized table entry.
   */
  amqp_table_entry_t amqp_table_construct_utf8_entry(const char *key,
                                                     const char *value);
  
  /**
   * Initializes a table entry with table type value.
   *
   * \param [in] key the table entry key. The string must remain value for the
   * life of the resulting amqp_table_entry_t.
   * \param [in] value the amqp_table_t value. The table must remain valid for the
   * life of the resulting amqp_table_entry_t.
   * \returns An initialized table entry.
   */
  amqp_table_entry_t amqp_table_construct_table_entry(const char *key,
                                                      const amqp_table_t *value);
  
  /**
   * Initializes a table entry with boolean type value.
   *
   * \param [in] key the table entry key. The string must remain value for the
   * life of the resulting amqp_table_entry_t.
   * \param [in] value the boolean value. 0 means false, any other value is true.
   * \returns An initialized table entry.
   */
  amqp_table_entry_t amqp_table_construct_bool_entry(const char *key,
                                                     const int value);
  
  /**
   * Searches a table for an entry with a matching key.
   *
   * \param [in] table the table to search.
   * \param [in] key the string to search with.
   * \returns a pointer to the table entry in the table if a matching key can be
   * found, NULL otherwise.
   */
  amqp_table_entry_t *amqp_table_get_entry_by_key(const amqp_table_t *table,
                                                  const amqp_bytes_t key);
  
  #endif /* AMQP_TABLE_H */