blob: 122f332d5e2e839e9fd0e8d4c6796cd94383884a (
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
|
/*
* Copyright (c) 2017-2019 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 udpConnection.h
* @brief Represents a UDP connection (socket) for the connection table
*
* <#Detailed Description#>
*
*/
#ifndef udpConnection_h
#define udpConnection_h
#include <src/core/forwarder.h>
#include <src/io/addressPair.h>
#include <src/io/ioOperations.h>
#include <src/utils/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
*/
IoOperations *udpConnection_Create(Forwarder *forwarder, int fd,
const AddressPair *pair, bool isLocal);
#endif // udpConnection_h
|
