summaryrefslogtreecommitdiff
path: root/cpp/include/qpid/sys/SystemInfo.h
blob: 23594cf650856a50e0f1dad832b71058b2a99636 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
#ifndef QPID_SYS_SYSTEMINFO_H
#define QPID_SYS_SYSTEMINFO_H

/*
 * 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.
 *
 */

#include "qpid/sys/IntegerTypes.h"
#include "qpid/Address.h"
#include "qpid/CommonImportExport.h"
#include <vector>

namespace qpid {
namespace sys {

/**
 * Retrieve information about the system we are running on.
 * Results may be dependent on OS/hardware.
 */
namespace SystemInfo {
    /**
     * Estimate available concurrency, e.g. number of CPU cores.
     * -1 means estimate not available on this platform.
     */
    QPID_COMMON_EXTERN long concurrency();

    /**
     * Get the local host name and set it in the specified.
     * Returns false if it can't be obtained and sets errno to any error value.
     */
    QPID_COMMON_EXTERN bool getLocalHostname (Address &address);

    QPID_COMMON_EXTERN void getLocalIpAddresses (uint16_t port, std::vector<Address> &addrList);

    /**
     * Retrieve system identifiers and versions. This is information that can
     * generally be retrieved via POSIX uname().
     *
     * @param osName   Receives the OS name; e.g., GNU/Linux or Windows
     * @param nodeName Receives the nodename. This may or may not match the
     *                 set hostname from getLocalHostname().
     * @param release  Receives the OS release identifier.
     * @param version  Receives the OS release version (kernel, build, sp, etc.)
     * @param machine  Receives the hardware type.
     */
    QPID_COMMON_EXTERN void getSystemId (std::string &osName,
                      std::string &nodeName,
                      std::string &release,
                      std::string &version,
                      std::string &machine);

    /**
     * Get the process ID of the current process.
     */
    QPID_COMMON_EXTERN uint32_t getProcessId();

    /**
     * Get the process ID of the parent of the current process.
     */
    QPID_COMMON_EXTERN uint32_t getParentProcessId();

    /**
     * Get the name of the current process (i.e. the name of the executable)
     */
    QPID_COMMON_EXTERN std::string getProcessName();


}}} // namespace qpid::sys::SystemInfo

#endif  /*!QPID_SYS_SYSTEMINFO_H*/