diff options
Diffstat (limited to 'tinySIGCOMP/src/tcomp_nackinfo.h')
| -rw-r--r-- | tinySIGCOMP/src/tcomp_nackinfo.h | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/tinySIGCOMP/src/tcomp_nackinfo.h b/tinySIGCOMP/src/tcomp_nackinfo.h new file mode 100644 index 0000000..5a1e427 --- /dev/null +++ b/tinySIGCOMP/src/tcomp_nackinfo.h @@ -0,0 +1,111 @@ +/* +* Copyright (C) 2010-2011 Mamadou Diop. +* +* Contact: Mamadou Diop <diopmamadou(at)doubango[dot]org> +* +* This file is part of Open Source Doubango Framework. +* +* DOUBANGO is free software: you can redistribute it and/or modify +* it under the terms of the GNU General Public License as published by +* the Free Software Foundation, either version 3 of the License, or +* (at your option) any later version. +* +* DOUBANGO is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License +* along with DOUBANGO. +* +*/ + +/**@file tcomp_nackinfo.h + * @brief RFC 4077 - A Negative Acknowledgement Mechanism for Signaling Compression (NACK) + * + * @author Mamadou Diop <diopmamadou(at)yahoo.fr> + * + + */ +#ifndef TCOMP_NAKINFO_H +#define TCOMP_NAKINFO_H + +#include "tinysigcomp_config.h" +#include "tcomp_buffer.h" + +#include "tsk_sha1.h" +#include "tsk_object.h" + +TCOMP_BEGIN_DECLS + +struct tcomp_message_s; + +/* ++---+---+---+---+---+---+---+---+ +| code_len = 0 | ++---+---+---+---+---+---+---+---+ +| code_len = 0 | version = 1 | ++---+---+---+---+---+---+---+---+ +| Reason Code | ++---+---+---+---+---+---+---+---+ +| OPCODE of failed instruction | ++---+---+---+---+---+---+---+---+ +| PC of failed instruction | +| | ++---+---+---+---+---+---+---+---+ +| | +: SHA-1 Hash of failed message : +| | ++---+---+---+---+---+---+---+---+ +| | +: Error Details : +| | ++---+---+---+---+---+---+---+---+ +*/ +/**NACK info as per rfc 4077 subclause 3.1. +* You MUST use @ref tcomp_nackinfo_create() to create new nackinfo object. +*/ +typedef struct tcomp_nackinfo_s +{ + TSK_DECLARE_OBJECT; + + uint8_t version; /**< Gives the version of the NACK mechanism being employed. */ + uint8_t reasonCode; /**< The Reason Code is a one-byte value that indicates the nature of the decompression failure. */ + uint8_t opcode; /**< The "OPCODE of failed instruction" is a one-byte field that includes the opcode to which the PC was pointing when the failure occurred */ + uint32_t pc; /**< "PC of failed instruction" is a two-byte field containing the value of the program counter when failure occurred (i.e., the memory address of the failed UDVM instruction) */ + uint8_t sha1[TSK_SHA1_DIGEST_SIZE]; /**<"SHA-1 Hash of failed message" contains the full 20-byte SHA-1 hash of the SigComp message that could not be decompressed */ + tcomp_buffer_handle_t *details; /**< "Error Details" provides additional information that might be useful in correcting the problem that caused decompression failure.*/ +} +tcomp_nackinfo_t; + +tcomp_nackinfo_t* tcomp_nackinfo_create(); +int tcomp_nackinfo_write(tcomp_buffer_handle_t* buffer, + uint8_t reasonCode, + uint8_t opCode, + int16_t memory_address_of_instruction, + const void* sigCompMessagePtr, tsk_size_t sigCompMessageSize, + tcomp_buffer_handle_t* lpDetails, + uint16_t udvm_size, + uint8_t cpbValue); +int tcomp_nackinfo_write_2(tcomp_buffer_handle_t* buffer, + uint8_t reasonCode, + uint8_t opCode, + int16_t memory_address_of_instruction, + const struct tcomp_message_s* sigCompMessage, + tcomp_buffer_handle_t* lpDetails, + uint16_t udvm_size, + uint8_t cpbValue); +int tcomp_nackinfo_write_3(tcomp_buffer_handle_t* buffer, + uint8_t reasonCode, + const void* sigCompMessagePtr, tsk_size_t sigCompMessageSize); +int tcomp_nackinfo_write_4(tcomp_buffer_handle_t* buffer, + uint8_t reasonCode, + const struct tcomp_message_s* sigCompMessage); +TINYSIGCOMP_API const char* tcomp_nackinfo_get_description(const tcomp_buffer_handle_t* buffer); + + +TINYSIGCOMP_GEXTERN const tsk_object_def_t *tcomp_nackinfo_def_t; + +TCOMP_END_DECLS + +#endif /* TCOMP_NAKINFO_H */ |
