Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
http_response.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (c) Microsoft Corporation.
4 * All rights reserved.
5 *
6 * This code is licensed under the MIT License.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files(the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions :
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 *
26 */
27/**
28 * @brief Contains HttpResponse interface used by HttpDelegate
29 *
30 * @file http_response.h
31 */
32
33#ifndef API_MIP_HTTP_RESPONSE_H_
34#define API_MIP_HTTP_RESPONSE_H_
35
36#include <vector>
37
38#include "mip/common_types.h"
39#include "mip/mip_namespace.h"
40
41MIP_NAMESPACE_BEGIN
42
43/**
44 * @brief Interface that describes a single HTTP response, implemented by client app when overriding HttpDelegate
45 */
47public:
48 /**
49 * @brief Gets response ID
50 *
51 * @return Response ID
52 *
53 * @note The corresponding HttpRequest will have had the same ID
54 */
55 virtual const std::string& GetId() const = 0;
56
57 /**
58 * @brief Get response status code
59 *
60 * @return Status code
61 */
62 virtual int32_t GetStatusCode() const = 0;
63
64 /**
65 * @brief Get request body
66 *
67 * @return Request body
68 */
69 virtual const std::vector<uint8_t>& GetBody() const = 0;
70
71 /**
72 * @brief Get request headers
73 *
74 * @return Request headers
75 */
76 virtual const std::map<std::string, std::string, CaseInsensitiveComparator>& GetHeaders() const = 0;
77
78 /** @cond DOXYGEN_HIDE */
79 virtual ~HttpResponse() {}
80 /** @endcond */
81};
82
83MIP_NAMESPACE_END
84#endif // API_MIP_HTTP_RESPONSE_H_
85
Interface that describes a single HTTP response, implemented by client app when overriding HttpDelega...
virtual const std::map< std::string, std::string, CaseInsensitiveComparator > & GetHeaders() const =0
Get request headers.
virtual const std::vector< uint8_t > & GetBody() const =0
Get request body.
virtual int32_t GetStatusCode() const =0
Get response status code.
virtual const std::string & GetId() const =0
Gets response ID.
A file Containing the common types used by the upe, file and protection modules.
MIP namespace macros.