xref: /FreeRTOS-Plus-TCP-v4.0.0/source/include/FreeRTOS_DNS_Networking.h (revision 2d3f4daa567ffe71aeda2e0f6d0bc02850db0627)
1 /*
2  * FreeRTOS+TCP <DEVELOPMENT BRANCH>
3  * Copyright (C) 2022 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
4  *
5  * SPDX-License-Identifier: MIT
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy of
8  * this software and associated documentation files (the "Software"), to deal in
9  * the Software without restriction, including without limitation the rights to
10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
11  * the Software, and to permit persons to whom the Software is furnished to do so,
12  * subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in all
15  * copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
19  * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
20  * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
21  * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * https://github.com/FreeRTOS
25  * https://www.FreeRTOS.org
26  */
27 #ifndef FREERTOS_DNS_NETWORKING_H
28 #define FREERTOS_DNS_NETWORKING_H
29 
30 #include "FreeRTOS_IP.h"
31 #include "FreeRTOS_Sockets.h"
32 #include "FreeRTOS_DNS_Globals.h"
33 
34 #if ( ipconfigUSE_DNS != 0 )
35 
36 /*
37  * Create a socket and bind it to the standard DNS port number.  Return the
38  * the created socket - or NULL if the socket could not be created or bound.
39  */
40     Socket_t DNS_CreateSocket( TickType_t uxReadTimeOut_ticks );
41 
42 /**
43  * @brief Bind the socket to a port number.
44  * @param[in] xSocket: the socket that must be bound.
45  * @param[in] usPort: the port number to bind to.
46  * @return The created socket - or NULL if the socket could not be created or could not be bound.
47  */
48     BaseType_t DNS_BindSocket( Socket_t xSocket,
49                                uint16_t usPort );
50 
51     BaseType_t DNS_SendRequest( Socket_t xDNSSocket,
52                                 const struct freertos_sockaddr * xAddress,
53                                 const struct xDNSBuffer * pxDNSBuf );
54 
55     BaseType_t DNS_ReadReply( ConstSocket_t xDNSSocket,
56                               struct freertos_sockaddr * xAddress,
57                               struct xDNSBuffer * pxReceiveBuffer );
58 
59     void DNS_CloseSocket( Socket_t xDNSSocket );
60 
61 #endif /* if ( ipconfigUSE_DNS != 0 ) */
62 #endif /* ifndef FREERTOS_DNS_NETWORKING_H */
63