OceanDirectLighthouseC++ 3.1.3
OceanDirect Lighthouse C++/C API
EthernetAPI.h
Go to the documentation of this file.
1/*****************************************************
2 * @file EthernetAPI.h
3 * @date May 2022
4 * @author Ocean Insight, Inc.
5 *
6 * This is an interface to OceanDirect that allows
7 * the user to read and write user strin to device.
8 * This is intended as a usable and extensible API.
9 */
10 /************************************************************************
11 *
12 * OCEAN INSIGHT CONFIDENTIAL
13 * __________________
14 *
15 * [2018] - [2022] Ocean Insight Incorporated
16 * All Rights Reserved.
17 *
18 * NOTICE: All information contained herein is, and remains
19 * the property of Ocean Insight Incorporated and its suppliers,
20 * if any. The intellectual and technical concepts contained
21 * herein are proprietary to Ocean Insight Incorporated
22 * and its suppliers and may be covered by U.S. and Foreign Patents,
23 * patents in process, and are protected by trade secret or copyright law.
24 * Dissemination of this information or reproduction of this material
25 * is strictly forbidden unless prior written permission is obtained
26 * from Ocean Insight Incorporated.
27 *
28 **************************************************************************/
29
30#ifndef ETHERNET_API_H
31#define ETHERNET_API_H
32
33#include "api/DllDecl.h"
34#include <cstdint>
41namespace oceandirect {
42 namespace api {
43
44 class DLL_DECL EthernetAPI {
45 public:
46 EthernetAPI() = default;
47 virtual ~EthernetAPI() = default;
49
50 static void shutdown();
51
52
65 virtual bool getGigabitEthernetEnableStatus(long deviceID, int* errorCode, std::uint32_t interfaceIndex);
66
79 virtual void setGigabitEthernetEnableStatus(long deviceID, int* errorCode, std::uint32_t interfaceIndex, bool enable);
80
94 virtual void getMACAddress(long deviceID, int* errorCode, std::uint32_t interfaceIndex, std::uint8_t *macAddress, std::uint32_t macAddressLength);
95
109 virtual void setMACAddress(long deviceID, int* errorCode, std::uint32_t interfaceIndex, std::uint8_t* macAddress, std::uint32_t macAddressLength);
110
111 protected:
113 };
114 }
115}
116#endif /* ETHERNET_API_H */
Definition EthernetAPI.h:44
static EthernetAPI * instance
Definition EthernetAPI.h:112
static EthernetAPI * getInstance()
virtual ~EthernetAPI()=default
virtual void getMACAddress(long deviceID, int *errorCode, std::uint32_t interfaceIndex, std::uint8_t *macAddress, std::uint32_t macAddressLength)
virtual bool getGigabitEthernetEnableStatus(long deviceID, int *errorCode, std::uint32_t interfaceIndex)
virtual void setGigabitEthernetEnableStatus(long deviceID, int *errorCode, std::uint32_t interfaceIndex, bool enable)
virtual void setMACAddress(long deviceID, int *errorCode, std::uint32_t interfaceIndex, std::uint8_t *macAddress, std::uint32_t macAddressLength)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition OceanDirectAPI.h:147