dhcpsapi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de1b8659955ca630bb905e80a25a5f9cd3da392
-  data.tar.gz: e084547979b41c1943dcc23a411a8b00c45cb8e4
+  metadata.gz: c9740f4c12d6acbd2ec1543f1b2df97e2b4ecd80
+  data.tar.gz: 89ebad17dc6a96c7354a06754dfc79f76d7bde8c
 SHA512:
-  metadata.gz: 795bb44c1631a4b0144a9c668644fcd95ed8f12a2dd2ed64f4b41f1ab4664eedda2d19a493b9a1da0eee82f6c0717ab63f2f2c857c00fa15235d5fcea80e84f1
-  data.tar.gz: 1074863887ba322813fc7a034debc55f3ff55b372bb5533455c01725f086d3ba0c8fdbe73b30b08af88e85492d37cb20f3b3c714d06530fa6f9001324684ea5e
+  metadata.gz: d389e520e1ab8e5e29920b6a29c082f71a4d4b5a42021c4ba201d2ce1a71c7f2c355e9c1b420290d7c8fdd34972d7e25a50dc1e5423a62610133f11f659cc5dd
+  data.tar.gz: 66f36da0548a51a88bf410f3fb91cce72da8eb5cdf5a8ba0680a051cac1842b7ac04c14b91fc959b4ad0566f5683ebb0842d8233f9ead53a9d88d81db7a3bb9f

data/lib/dhcpsapi/class.rb

@@ -1,78 +1,4 @@
 module DhcpsApi
-  #
-  # DHCP_CLASS_INFO data structure describes an option class.
-  #
-  # Available fields:
-  # :class_name [String],
-  # :class_comment [String],
-  # :is_vendor [Boolean],
-  # :flags [Fixnum],
-  # :class_data [String]
-  #
-  # @see https://msdn.microsoft.com/en-us/library/windows/desktop/dd897569(v=vs.85).aspx
-  #
-  class DHCP_CLASS_INFO < DHCPS_Struct
-    layout :class_name, :pointer,
-           :class_comment, :pointer,
-           :class_data_length, :uint32,
-           :is_vendor, :bool,
-           :flags, :uint32,
-           :class_data, :pointer
-
-    ruby_struct_attr :to_string, :class_name, :class_comment, :policy_name
-    ruby_struct_attr :class_data_as_string, :class_data
-
-    private
-    def class_data_as_string(unused)
-      self[:class_data].read_array_of_type(:uint8, :read_uint8, self[:class_data_length])
-    end
-  end
-
-  #
-  # DHCP_CLASS_INFO data structure describes an array of option classes.
-  #
-  # Available fields:
-  # :num_elements [Fixnum],
-  # :classes [Array<Hash>]
-  #
-  # @see https://msdn.microsoft.com/en-us/library/windows/desktop/dd897570(v=vs.85).aspx
-  #
-  class DHCP_CLASS_INFO_ARRAY < DHCPS_Struct
-    layout :num_elements, :uint32,
-           :classes, :pointer
-  end
-
-=begin
-  DWORD DhcpEnumClasses(
-    _In_    LPWSTR                  ServerIpAddress,
-    _In_    DWORD                   ReservedMustBeZero,
-    _Inout_  DHCP_RESUME_HANDLE     *ResumeHandle,
-    _In_    DWORD                   PreferredMaximum,
-    _Out_   LPDHCP_CLASS_INFO_ARRAY *ClassInfoArray,
-    _Out_   DWORD                   *nRead,
-    _Out_   DWORD                   *nTotal
-  );
-=end
-  attach_function :DhcpEnumClasses, [:pointer, :uint32, :pointer, :uint32, :pointer, :pointer, :pointer], :uint32
-
-=begin
-  DWORD DhcpCreateClass(
-    _In_ LPWSTR            ServerIpAddress,
-    _In_ DWORD             ReservedMustBeZero,
-    _In_ LPDHCP_CLASS_INFO ClassInfo
-  );
-=end
-  attach_function :DhcpCreateClass, [:pointer, :uint32, :pointer], :uint32
-
-=begin
-  DWORD DhcpDeleteClass(
-    _In_ LPWSTR ServerIpAddress,
-    _In_ DWORD  ReservedMustBeZero,
-    _In_ LPWSTR ClassName
-  );
-=end
-  attach_function :DhcpDeleteClass, [:pointer, :uint32, :pointer], :uint32
-
   module Class
     # Returns option classes available on the server as a List of DHCP_CLASS_INFOs represented as Hashmaps.
     #
@@ -111,7 +37,7 @@ module DhcpsApi
       to_create[:class_data] = FFI::MemoryPointer.from_string(to_wchar_string(data))
       to_create[:class_data_length] = to_wchar_string(data).bytes.size
 
-      error = DhcpsApi.DhcpCreateClass(to_wchar_string(server_ip_address), 0, to_create.pointer)
+      error = DhcpsApi::Win2008::Class.DhcpCreateClass(to_wchar_string(server_ip_address), 0, to_create.pointer)
       raise DhcpsApi::Error.new("Error creating class.", error) if error != 0
 
       to_create.as_ruby_struct
@@ -128,7 +54,7 @@ module DhcpsApi
     # @return [void]
     #
     def delete_class(class_name)
-      error = DhcpsApi.DhcpDeleteClass(to_wchar_string(server_ip_address), 0, to_wchar_string(class_name))
+      error = DhcpsApi::Win2008::Class.DhcpDeleteClass(to_wchar_string(server_ip_address), 0, to_wchar_string(class_name))
       raise DhcpsApi::Error.new("Error deleting class.", error) if error != 0
     end
 
@@ -139,7 +65,7 @@ module DhcpsApi
       elements_read_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
       elements_total_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
 
-      error = DhcpsApi.DhcpEnumClasses(
+      error = DhcpsApi::Win2008::Class.DhcpEnumClasses(
           to_wchar_string(server_ip_address), 0, resume_handle_ptr, preferred_maximum,
           class_info_ptr_ptr, elements_read_ptr, elements_total_ptr)
 

data/lib/dhcpsapi/client.rb

@@ -1,127 +1,4 @@
 module DhcpsApi
-=begin
-  typedef struct _DHCP_CLIENT_INFO_PB {
-    DHCP_IP_ADDRESS  ClientIpAddress;
-    DHCP_IP_MASK     SubnetMask;
-    DHCP_CLIENT_UID  ClientHardwareAddress;
-    LPWSTR           ClientName;
-    LPWSTR           ClientComment;
-    DATE_TIME        ClientLeaseExpires;
-    DHCP_HOST_INFO   OwnerHost;
-    BYTE             bClientType;
-    BYTE             AddressState;
-    QuarantineStatus Status;
-    DATE_TIME        ProbationEnds;
-    BOOL             QuarantineCapable;
-    DWORD            FilterStatus;
-    LPWSTR           PolicyName;
-  } DHCP_CLIENT_INFO_PB, *LPDHCP_CLIENT_INFO_PB;
-=end
-  class DHCP_CLIENT_INFO_PB < DHCPS_Struct
-    layout  :client_ip_address, :uint32,
-            :subnet_mask, :uint32,
-            :client_hardware_address, DHCP_CLIENT_UID,
-            :client_name, :pointer,
-            :client_comment, :pointer,
-            :client_lease_expires, DATE_TIME,
-            :owner_host, DHCP_HOST_INFO,
-            :b_client_type, :uint8, # see ClientType
-            :address_state, :uint8,
-            :status, :uint32,
-            :probation_ends, DATE_TIME,
-            :quarantine_capable, :bool,
-            :filter_status, :uint32,
-            :policy_name, :pointer
-
-    ruby_struct_attr :uint32_to_ip, :client_ip_address, :subnet_mask
-    ruby_struct_attr :dhcp_client_uid_to_mac, :client_hardware_address
-    ruby_struct_attr :to_string, :client_name, :client_comment, :policy_name
-  end
-
-=begin
-  typedef struct _DHCP_CLIENT_INFO_V4 {
-    DHCP_IP_ADDRESS ClientIpAddress;
-    DHCP_IP_MASK    SubnetMask;
-    DHCP_CLIENT_UID ClientHardwareAddress;
-    LPWSTR          ClientName;
-    LPWSTR          ClientComment;
-    DATE_TIME       ClientLeaseExpires;
-    DHCP_HOST_INFO  OwnerHost;
-    BYTE            bClientType;
-  } DHCP_CLIENT_INFO_V4, *LPDHCP_CLIENT_INFO_V4;
-=end
-  class DHCP_CLIENT_INFO_V4 < DHCPS_Struct
-    layout :client_ip_address, :uint32,
-           :subnet_mask, :uint32,
-           :client_hardware_address, DHCP_CLIENT_UID,
-           :client_name, :pointer,
-           :client_comment, :pointer,
-           :client_lease_expires, DATE_TIME,
-           :owner_host, DHCP_HOST_INFO,
-           :client_type, :uint8 # see ClientType
-
-    ruby_struct_attr :uint32_to_ip, :client_ip_address, :subnet_mask
-    ruby_struct_attr :dhcp_client_uid_to_mac, :client_hardware_address
-    ruby_struct_attr :to_string, :client_name, :client_comment
-  end
-
-=begin
-typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
-  DWORD                 NumElements;
-  LPDHCP_CLIENT_INFO_PB *Clients;
-} DHCP_CLIENT_INFO_PB_ARRAY, *LPDHCP_CLIENT_INFO_PB_ARRAY;
-=end
-  class DHCP_CLIENT_INFO_PB_ARRAY < DHCPS_Struct
-    layout :num_elements, :uint32,
-           :clients, :pointer
-  end
-
-=begin
-  DWORD DhcpCreateClientInfoV4(
-    _In_ DHCP_CONST WCHAR                 *ServerIpAddress,
-    _In_ LPDHCP_CONST DHCP_CLIENT_INFO_V4 ClientInfo
-  );
-=end
-  attach_function :DhcpCreateClientInfoV4, [:pointer, :pointer], :uint32
-
-=begin
-  DWORD DhcpSetClientInfoV4(
-    _In_ DHCP_CONST WCHAR               *ServerIpAddress,
-    _In_ DHCP_CONST DHCP_CLIENT_INFO_V4 *ClientInfo
-  );
-=end
-  attach_function :DhcpSetClientInfoV4, [:pointer, :pointer], :uint32
-
-=begin
-  DWORD DHCP_API_FUNCTION DhcpGetClientInfoV4(
-    _In_  DHCP_CONST WCHAR            ServerIpAddress,
-    _In_  DHCP_CONST DHCP_SEARCH_INFO SearchInfo,
-    _Out_ LPDHCP_CLIENT_INFO_V4       *ClientInfo
-  );
-=end
-  attach_function :DhcpGetClientInfoV4, [:pointer, DHCP_SEARCH_INFO.by_value, :pointer], :uint32
-
-=begin
-  DWORD DHCP_API_FUNCTION DhcpV4EnumSubnetClients(
-    _In_opt_ DHCP_CONST WCHAR            *ServerIpAddress,
-    _In_     DHCP_IP_ADDRESS             SubnetAddress,
-    _Inout_  DHCP_RESUME_HANDLE          *ResumeHandle,
-    _In_     DWORD                       PreferredMaximum,
-    _Out_    LPDHCP_CLIENT_INFO_PB_ARRAY *ClientInfo,
-    _Out_    DWORD                       *ClientsRead,
-    _Out_    DWORD                       *ClientsTotal
-  );
-=end
-  attach_function :DhcpV4EnumSubnetClients, [:pointer, :uint32, :pointer, :uint32, :pointer, :pointer, :pointer], :uint32
-
-=begin
-  DWORD DHCP_API_FUNCTION DhcpDeleteClientInfo(
-    _In_ DHCP_CONST WCHAR            *ServerIpAddress,
-    _In_ DHCP_CONST DHCP_SEARCH_INFO *ClientInfo
-  );
-=end
-  attach_function :DhcpDeleteClientInfo, [:pointer, :pointer], :uint32
-
   module Client
     def list_clients(subnet_address)
       items, _ = retrieve_items(:dhcp_v4_enum_subnet_clients, subnet_address, 1024, 0)
@@ -143,7 +20,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
       to_create[:client_lease_expires][:dw_high_date_time] = 0
       to_create[:client_type] = client_type
 
-      error = DhcpsApi.DhcpCreateClientInfoV4(to_wchar_string(server_ip_address), to_create.pointer)
+      error = DhcpsApi::Win2008::Client.DhcpCreateClientInfoV4(to_wchar_string(server_ip_address), to_create.pointer)
       raise DhcpsApi::Error.new("Error creating client.", error) if error != 0
 
       to_create.as_ruby_struct
@@ -164,7 +41,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
       to_modify[:client_lease_expires][:dw_high_date_time] = 0
       to_modify[:client_type] = client_type
 
-      error = DhcpsApi.DhcpSetClientInfoV4(to_wchar_string(server_ip_address), to_modify.pointer)
+      error = DhcpsApi::Win2008::Client.DhcpSetClientInfoV4(to_wchar_string(server_ip_address), to_modify.pointer)
       raise DhcpsApi::Error.new("Error modifying client.", error) if error != 0
 
       to_modify.as_ruby_struct
@@ -203,7 +80,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
       search_info[:search_type] = DhcpsApi::DHCP_SEARCH_INFO_TYPE::DhcpClientHardwareAddress
       search_info[:search_info][:client_hardware_address].initialize_with_subnet_and_mac_addresses(subnet_address, client_mac_address)
 
-      error = DhcpsApi.DhcpDeleteClientInfo(to_wchar_string(server_ip_address), search_info.pointer)
+      error = DhcpsApi::Win2008::Client.DhcpDeleteClientInfo(to_wchar_string(server_ip_address), search_info.pointer)
       raise DhcpsApi::Error.new("Error deleting client.", error) if error != 0
     end
 
@@ -212,7 +89,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
       search_info[:search_type] = DhcpsApi::DHCP_SEARCH_INFO_TYPE::DhcpClientIpAddress
       search_info[:search_info][:client_ip_address] = ip_to_uint32(client_ip_address)
 
-      error = DhcpsApi.DhcpDeleteClientInfo(to_wchar_string(server_ip_address), search_info.pointer)
+      error = DhcpsApi::Win2008::Client.DhcpDeleteClientInfo(to_wchar_string(server_ip_address), search_info.pointer)
       raise DhcpsApi::Error.new("Error deleting client.", error) if error != 0
     end
 
@@ -221,7 +98,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
       search_info[:search_type] = DhcpsApi::DHCP_SEARCH_INFO_TYPE::DhcpClientName
       search_info[:search_info][:client_name] = FFI::MemoryPointer.from_string(to_wchar_string(client_name))
 
-      error = DhcpsApi.DhcpDeleteClientInfo(to_wchar_string(server_ip_address), search_info.pointer)
+      error = DhcpsApi::Win2008::Client.DhcpDeleteClientInfo(to_wchar_string(server_ip_address), search_info.pointer)
       raise DhcpsApi::Error.new("Error deleting client.", error) if error != 0
     end
 
@@ -229,7 +106,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
     def get_client(search_info, client_id)
       client_info_ptr_ptr = FFI::MemoryPointer.new(:pointer)
 
-      error = DhcpsApi.DhcpGetClientInfoV4(to_wchar_string(server_ip_address), search_info.pointer, client_info_ptr_ptr)
+      error = DhcpsApi::Win2008::Client.DhcpGetClientInfoV4(to_wchar_string(server_ip_address), search_info.pointer, client_info_ptr_ptr)
       if is_error?(error)
         unless (client_info_ptr_ptr.null? || (to_free = client_info_ptr_ptr.read_pointer).null?)
           free_memory(DhcpsApi::DHCP_CLIENT_INFO_V4.new(to_free))
@@ -250,7 +127,7 @@ typedef struct _DHCP_CLIENT_INFO_PB_ARRAY {
       elements_read_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
       elements_total_ptr = FFI::MemoryPointer.new(:uint32).put_uint32(0, 0)
 
-      error = DhcpsApi.DhcpV4EnumSubnetClients(
+      error = DhcpsApi::Win2012::Client.DhcpV4EnumSubnetClients(
           to_wchar_string(server_ip_address), ip_to_uint32(subnet_address), resume_handle_ptr, preferred_maximum,
           client_info_ptr_ptr, elements_read_ptr, elements_total_ptr)
       return empty_response if error == 259

data/lib/dhcpsapi/common.rb

@@ -63,17 +63,10 @@ module DhcpsApi
     end
   end
 
-=begin
-VOID DHCP_API_FUNCTION DhcpRpcFreeMemory(
-   PVOID BufferPointer
-);
-=end
-  attach_function :DhcpRpcFreeMemory, [:pointer], :void
-
 # @private
   module CommonMethods
     def free_memory(a_struct)
-      DhcpsApi.DhcpRpcFreeMemory(a_struct.pointer)
+      DhcpsApi::Win2008::Common.DhcpRpcFreeMemory(a_struct.pointer)
     end
 
     def retrieve_items(method_to_call, *args)