diff options
author | Michele Papalini <micpapal+fdio@cisco.com> | 2017-02-24 08:00:13 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@fd.io> | 2017-02-24 08:00:13 +0000 |
commit | 6d4b6878ceff22f9ec8d8e9423214f9666007472 (patch) | |
tree | fa27e0c747676519cb87ff8448bfed62fce5009d /libccnx-transport-rta/ccnx/transport/transport_rta/connectors/rta_ApiConnection.h | |
parent | f28308bd99381ef5f1e178e2e1f870f245e35873 (diff) | |
parent | d18ae43123fcd7604d1c36a1ec8450dbe6071824 (diff) |
Merge "Initial commit: ccnxlibs." into ccnxlibs/master
Diffstat (limited to 'libccnx-transport-rta/ccnx/transport/transport_rta/connectors/rta_ApiConnection.h')
-rw-r--r-- | libccnx-transport-rta/ccnx/transport/transport_rta/connectors/rta_ApiConnection.h | 83 |
1 files changed, 83 insertions, 0 deletions
diff --git a/libccnx-transport-rta/ccnx/transport/transport_rta/connectors/rta_ApiConnection.h b/libccnx-transport-rta/ccnx/transport/transport_rta/connectors/rta_ApiConnection.h new file mode 100644 index 00000000..799c45e6 --- /dev/null +++ b/libccnx-transport-rta/ccnx/transport/transport_rta/connectors/rta_ApiConnection.h @@ -0,0 +1,83 @@ +/* + * 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 rta_ApiConnection.h + * @brief Implementation of the API connection + * + * <#Detailed Description#> + * + */ + +#ifndef TransportRTA_rta_ApiConnection_h +#define TransportRTA_rta_ApiConnection_h + +struct rta_api_connection; +typedef struct rta_api_connection RtaApiConnection; + +#include <ccnx/transport/transport_rta/core/rta_Connection.h> + +RtaApiConnection *rtaApiConnection_Create(RtaConnection *connection); +void rtaApiConnection_Destroy(RtaApiConnection **rtaApiConnectionPtr); + +/** + * Sends a TransportMessage up to the API + * + * Decapsulates the ccnx message and sends it up to the API. It will destroy the TransportMessage wrapper. + * + * @param [in] apiConnection The API connection to write to + * @param [in] tm The transport message to send + * @param [in] stats The statistics counter to increment on success + * + * @return true Transport message written + * @return false Transport message not written (but still destroyed) + * + * Example: + * @code + * <#example#> + * @endcode + */ +bool rtaApiConnection_SendToApi(RtaApiConnection *apiConnection, TransportMessage *tm, RtaComponentStats *stats); + +/** + * Block data flow in the DOWN direction + * + * To block in the DOWN direction, we disable READ events on the API's buffer + * + * @param [in] apiConnection The API Connector's connection state + * @param [in] conn The RTA Connection + * + * Example: + * @code + * <#example#> + * @endcode + */ +void rtaApiConnection_BlockDown(RtaApiConnection *apiConnection); + +/** + * Unblock data flow in the DOWN direction + * + * To unblock in the DOWN direction, we enable READ events on the API's buffer + * + * @param [in] apiConnection The API Connector's connection state + * @param [in] conn The RTA Connection + * + * Example: + * @code + * <#example#> + * @endcode + */ +void rtaApiConnection_UnblockDown(RtaApiConnection *apiConnection); +#endif |