diff options
Diffstat (limited to 'metis/ccnx/forwarder/metis/io/metis_UdpConnection.h')
-rw-r--r-- | metis/ccnx/forwarder/metis/io/metis_UdpConnection.h | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/metis/ccnx/forwarder/metis/io/metis_UdpConnection.h b/metis/ccnx/forwarder/metis/io/metis_UdpConnection.h new file mode 100644 index 00000000..86af9296 --- /dev/null +++ b/metis/ccnx/forwarder/metis/io/metis_UdpConnection.h @@ -0,0 +1,51 @@ +/* + * 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 metis_UdpConnection.h + * @brief Represents a UDP connection (socket) for the connection table + * + * <#Detailed Description#> + * + */ + +#ifndef Metis_metis_UdpConnection_h +#define Metis_metis_UdpConnection_h + +#include <ccnx/forwarder/metis/io/metis_IoOperations.h> +#include <ccnx/forwarder/metis/core/metis_Forwarder.h> +#include <ccnx/forwarder/metis/io/metis_AddressPair.h> +#include <ccnx/api/control/cpi_Address.h> + +/** + * Creates a UDP connection that can send to the remote address + * + * The address pair must both be same type (i.e. INET or INET6). + * + * @param [in] metis An allocated MetisForwarder (saves reference) + * @param [in] fd The socket to use + * @param [in] pair An allocated address pair for the connection (saves reference) + * @param [in] isLocal determines if the remote address is on the current system + * + * @retval non-null An allocated Io operations + * @retval null An error + * + * Example: + * @code + * <#example#> + * @endcode + */ +MetisIoOperations *metisUdpConnection_Create(MetisForwarder *metis, int fd, const MetisAddressPair *pair, bool isLocal); +#endif // Metis_metis_UdpConnection_h |