blob: 77f846e547e1f9a2aa444ad5e44734e0385f555f (
plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file cpi_CancelFlow.h
* @brief Cancel a "flow"
*
*/
#ifndef libccnx_cpi_CancelFlow_h
#define libccnx_cpi_CancelFlow_h
#include <ccnx/api/control/cpi_ControlMessage.h>
#include <ccnx/common/ccnx_Name.h>
/**
* Creates a CPI reqeust to cancel a flow
*
* Will return an asynchronous ACK or NACK.
*
* @param name The CCNxName of the flow to cancel.
* @return A pointer to a valid CPIControlMessage
*
* Example:
* @code
* <#example#>
* @endcode
*/
PARCJSON *cpiCancelFlow_CreateRequest(const CCNxName *name);
/**
* Creates a CPI reqeust to cancel a flow
*
* @param [in] name The CCNxName of the flow to cancel.
*
* @return NULL An error occurred
* @return non-NULL A pointer to a valid PARCJSON instance.
*
* Example:
* @code
* {
* <#example#>
* }
* @endcode
*/
PARCJSON *cpiCancelFlow_Create(const CCNxName *name);
/**
* Return the CCNxName associated with the given control message
*
* @param controlMessage A pointer to a control message.
* @return A pointer to a valid CCNxName instance.
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxName *cpiCancelFlow_GetFlowName(const PARCJSON *controlMessage);
/**
* Return the name associated with the message
*
* @param controlMessage A pointer to a control message.
* @return A pointer to a valid CCNxName instance.
*
* Example:
* @code
* <#example#>
* @endcode
*/
CCNxName *cpiCancelFlow_NameFromControlMessage(CCNxControl *controlMessage);
/**
* Given a CPI response (ACK or NACK) return the success state
*
* @param controlMessage A pointer to a control message.
* @return true if the control message signals success.
*
* Example:
* @code
* <#example#>
* @endcode
*/
bool cpiCancelFlow_SuccessFromResponse(CCNxControl *controlMessage);
/**
* The CPI tag used for cancel flow
*
* Example:
* @code
* <#example#>
* @endcode
*/
const char *cpiCancelFlow_CancelFlowJsonTag(void);
#endif // libccnx_cpi_CancelFlow_h
|
