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
|
/**
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you 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 utils.h
* @brief Contains utility functions available to users of the api.
*
*/
#pragma once
#include <string>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <cstdint>
#ifndef ATSCPPAPI_UNUSED
#ifdef __GNUC__
#define ATSCPPAPI_UNUSED __attribute__((unused))
#else
#define ATSCPPAPI_UNUSED
#endif
#endif
namespace atscppapi
{
namespace utils
{
/**
* @brief Returns a pretty printed string of a sockaddr *
*
* @param sockaddr* A pointer to a sockaddr *
* @return a string which is the pretty printed address
*/
std::string getIpString(const sockaddr *);
/**
* @brief Returns just the port portion of the sockaddr *
*
* @param sockaddr* A pointer to a sockaddr *
* @return a uint16_t which is the port from the sockaddr *
*/
uint16_t getPort(const sockaddr *);
/**
* @brief Returns a pretty printed string of a sockaddr * including port
*
* @param sockaddr* A pointer to a sockaddr *
* @return a string which is the pretty printed address including port
*/
std::string getIpPortString(const sockaddr *);
} // namespace utils
} // namespace atscppapi
|
