| 1 | /*
|
|---|
| 2 | * Copyright (c) 2009 Lukas Mejdrech
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup libc
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 |
|
|---|
| 33 | /** @file
|
|---|
| 34 | * Character string with measured length.
|
|---|
| 35 | * The structure has been designed for serialization of character strings
|
|---|
| 36 | * between modules.
|
|---|
| 37 | */
|
|---|
| 38 |
|
|---|
| 39 | #ifndef LIBC_MEASURED_STRINGS_H_
|
|---|
| 40 | #define LIBC_MEASURED_STRINGS_H_
|
|---|
| 41 |
|
|---|
| 42 | #include <sys/types.h>
|
|---|
| 43 |
|
|---|
| 44 | /** Type definition of the character string with measured length.
|
|---|
| 45 | * @see measured_string
|
|---|
| 46 | */
|
|---|
| 47 | typedef struct measured_string measured_string_t;
|
|---|
| 48 |
|
|---|
| 49 | /** Type definition of the character string with measured length pointer.
|
|---|
| 50 | * @see measured_string
|
|---|
| 51 | */
|
|---|
| 52 | typedef measured_string_t *measured_string_ref;
|
|---|
| 53 |
|
|---|
| 54 | /** Character string with measured length.
|
|---|
| 55 | *
|
|---|
| 56 | * This structure has been designed for serialization of character strings
|
|---|
| 57 | * between modules.
|
|---|
| 58 | */
|
|---|
| 59 | struct measured_string {
|
|---|
| 60 | /** Character string data. */
|
|---|
| 61 | char * value;
|
|---|
| 62 | /** Character string length. */
|
|---|
| 63 | size_t length;
|
|---|
| 64 | };
|
|---|
| 65 |
|
|---|
| 66 | extern measured_string_ref measured_string_create_bulk(const char *, size_t);
|
|---|
| 67 | extern measured_string_ref measured_string_copy(measured_string_ref);
|
|---|
| 68 | extern int measured_strings_receive(measured_string_ref *, char **, size_t);
|
|---|
| 69 | extern int measured_strings_reply(const measured_string_ref, size_t);
|
|---|
| 70 | extern int measured_strings_return(int, measured_string_ref *, char **, size_t);
|
|---|
| 71 | extern int measured_strings_send(int, const measured_string_ref, size_t);
|
|---|
| 72 |
|
|---|
| 73 | #endif
|
|---|
| 74 |
|
|---|
| 75 | /** @}
|
|---|
| 76 | */
|
|---|
