OceanDirectLighthouseC++  3.1.1
OceanDirect Lighthouse C++/C API
DHCPServerConfigurationAPI.h
1 /*****************************************************
2  * @file DHCPServerConfigurationAPI.h
3  * @date August 2020
4  * @author Ocean Optics, Inc.
5  *
6  * This is an interface to OceanDirect that allows
7  * the user to connect to devices over USB and other buses.
8  * This is intended as a usable and extensible API.
9  */
10  /************************************************************************
11  *
12  * OCEAN INSIGHT CONFIDENTIAL
13  * __________________
14  *
15  * [2018] - [2020] 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 DHCPSERVERCONFIGURATIONAPI_H
31 #define DHCPSERVERCONFIGURATIONAPI_H
32 
33 #include "api/DllDecl.h"
34 
41 namespace oceandirect {
42  namespace api {
43 
44  class DLL_DECL DHCPServerConfigurationAPI {
45  public:
47  virtual ~DHCPServerConfigurationAPI();
48  static DHCPServerConfigurationAPI *getInstance();
49 
50  static void shutdown();
51 
64  bool isDHCPServerEnabled(long deviceID, int *errorCode, unsigned char ifNum);
65 
78  void setDHCPServerEnable(long deviceID, int *errorCode, unsigned char ifNum, unsigned char enabled);
79 
94  void readDHCPServerAddressRange(long deviceID, int *errorCode, unsigned char ifNum,
95  unsigned int *outBaseIpAddress, unsigned int ipAddressArraySize, unsigned int *outNetMask);
96 
111  void setDHCPServerAddressRange(long deviceID, int *errorCode, unsigned char ifNum,
112  const unsigned int *baseIpAddress, unsigned int ipAddressArraySize, unsigned int netMask);
113 
114  private:
115  static DHCPServerConfigurationAPI *instance;
116  };
117  }
118 }
119 #endif /* DHCPSERVERCONFIGURATIONAPI_H */
Definition: DHCPServerConfigurationAPI.h:44
void setDHCPServerAddressRange(long deviceID, int *errorCode, unsigned char ifNum, const unsigned int *baseIpAddress, unsigned int ipAddressArraySize, unsigned int netMask)
void setDHCPServerEnable(long deviceID, int *errorCode, unsigned char ifNum, unsigned char enabled)
void readDHCPServerAddressRange(long deviceID, int *errorCode, unsigned char ifNum, unsigned int *outBaseIpAddress, unsigned int ipAddressArraySize, unsigned int *outNetMask)
bool isDHCPServerEnabled(long deviceID, int *errorCode, unsigned char ifNum)
This is an interface to OceanDirect that allows the user to connect to devices over USB and other bus...
Definition: OceanDirectAPI.h:147