blob: 157ad20384fc0f598e70c2431f1db7bf39c17ed2 (
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
|
/*
* 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 ccnx_PortalRTA.h
* @brief The CCNxPortalStack representation of an "RTA" Transport Stack
*
*/
#ifndef __CCNx_Portal_API__ccnx_PortalRTA__
#define __CCNx_Portal_API__ccnx_PortalRTA__
#include <ccnx/api/ccnx_Portal/ccnx_PortalAttributes.h>
#include <ccnx/api/ccnx_Portal/ccnx_Portal.h>
/**
* Specification for an "RTA" Tranport Stack configured for Message-by-Message interaction.
*
* @param [in] factory A pointer to a valid {@link CCNxPortalFactory} instance.
* @param [in] attributes A pointer to a valid {@link CCNxPortalAttributes} instance.
*
* @return non-NULL A pointer to a valid {@link CCNxPortal} instance bound to the specified Transport Stack.
*
* Example:
* @code
* {
* CCNxPortal *portal = ccnxPortalFactory_CreatePortal(factory, ccnxPortalRTA_Message);
* }
* @endcode
*/
CCNxPortal *ccnxPortalRTA_Message(const CCNxPortalFactory *factory, const CCNxPortalAttributes *attributes);
/**
* Specification for an "RTA" Tranport Stack configured for Chunked interaction.
*
* The flow of inbound Content Objects is initiated by the first `CCNxInterest` specifying a valid Chunked protocol.
*
* @param [in] factory A pointer to a valid {@link CCNxPortalFactory} instance.
* @param [in] attributes A pointer to a valid {@link CCNxPortalAttributes} instance.
*
* @return non-NULL A pointer to a valid {@link CCNxPortal} instance bound to the specified Transport Stack.
*
* Example:
* @code
* {
* CCNxPortal *portal = ccnxPortalFactory_CreatePortal(factory, ccnxPortalRTA_Chunked);
* }
* @endcode
*/
CCNxPortal *ccnxPortalRTA_Chunked(const CCNxPortalFactory *factory, const CCNxPortalAttributes *attributes);
/**
* Specification for an "RTA" Tranport Stack configured for a loopback, Message-by-Message interaction.
*
* The loopback causes all messages sent to be reflected back to be received.
*
* @param [in] factory A pointer to a valid {@link CCNxPortalFactory} instance.
* @param [in] attributes A pointer to a valid {@link CCNxPortalAttributes} instance.
*
* @return non-NULL A pointer to a valid {@link CCNxPortal} instance bound to the specified Transport Stack.
*
* Example:
* @code
* {
* CCNxPortal *portal = ccnxPortalFactory_CreatePortal(factory, ccnxPortalRTA_LoopBack);
* }
* @endcode
*/
CCNxPortal *ccnxPortalRTA_LoopBack(const CCNxPortalFactory *factory, const CCNxPortalAttributes *attributes);
#endif /* defined(__CCNx_Portal_API__ccnx_PortalRTA__) */
|
