Microsoft Information Protection (MIP) SDK for C++: Reference 1.15
Doxygen-generated documentation for MIP SDK written in C++
Loading...
Searching...
No Matches
http_operation.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 HttpOperation interface used by HttpDelegate
29 *
30 * @file http_response.h
31 */
32
33#ifndef API_MIP_HTTP_OPERATION_H_
34#define API_MIP_HTTP_OPERATION_H_
35
36#include "mip/http_response.h"
37#include "mip/mip_namespace.h"
38
39MIP_NAMESPACE_BEGIN
40
41/**
42 * @brief Interface that describes a single HTTP operation, implemented by client app when overriding HttpDelegate
43 */
45public:
46 /**
47 * @brief Gets operation ID
48 *
49 * @return Operation ID
50 *
51 * @note The corresponding HttpRequest and HttpResponse will have the same ID
52 */
53 virtual const std::string& GetId() const = 0;
54
55 /**
56 * @brief Get response, if any
57 *
58 * @return Response
59 */
60 virtual std::shared_ptr<HttpResponse> GetResponse() = 0;
61
62 /**
63 * @brief Get cancellation status of operation
64 *
65 * @return Cancellation status
66 */
67 virtual bool IsCancelled() = 0;
68
69 /** @cond DOXYGEN_HIDE */
70 virtual ~HttpOperation() {}
71 /** @endcond */
72};
73
74MIP_NAMESPACE_END
75#endif // API_MIP_HTTP_OPERATION_H_
76
Interface that describes a single HTTP operation, implemented by client app when overriding HttpDeleg...
virtual std::shared_ptr< HttpResponse > GetResponse()=0
Get response, if any.
virtual const std::string & GetId() const =0
Gets operation ID.
virtual bool IsCancelled()=0
Get cancellation status of operation.
Contains HttpOperation interface used by HttpDelegate.
MIP namespace macros.