Skip to content

Latest commit

 

History

History
104 lines (84 loc) · 2.92 KB

set-IPv4.md

File metadata and controls

104 lines (84 loc) · 2.92 KB

SetIPv4

Sets the controller IPv4 address, netmask and gateway address.

Parameters

  • controller (T): Controller ID (uint32) or struct with controller ID, endpoint and protocol.
  • address (IPAddress): IPv4 address.
  • netmask (IPAddress): IPv4 netmask.
  • gateway (IPAddress): gateway IPv4 address.
  • options (Options): Bind, broadcast, and listen addresses.

Returns

Returns:

  • Ok
  • Error if the request failed

Examples

F#

let address = IPAddress.Parse "192.168.1.100"
let netmask = IPAddress.Parse "255.255.255.0"
let gateway = IPAddress.Parse "192.168.1.1"
let options = { broadcast = IPAddress.Broadcast; timeout = 1250; debug = true }

let controller = { 
    controller=405419896u; 
    endpoint=Some(IPEndPoint.Parse("192.168.1.100:60000")); 
    protocol=Some("tcp") }

match SetIPv4 405419896u address netmask gateway options with
| Ok record -> printfn "set-IPv4: ok"
| Error err -> printfn "set-IPv4: error %A" err

match SetIPv4 controller address netmask gateway options with
| Ok record -> printfn "set-IPv4: ok"
| Error err -> printfn "set-IPv4: error %A" err

C#

var address = IPAddress.Parse("192.168.1.100");
var netmask = IPAddress.Parse("255.255.255.0");
var gateway = IPAddress.Parse("192.168.1.1");
var options = new OptionsBuilder().WithTimeout(1250).build();

var controller = new uhppoted.CBuilder(405419896u)
                              .WithEndPoint(IPEndPoint.Parse("192.168.1.100:60000"))
                              .WithProtocol("udp")
                              .Build()

var result = SetIPv4(405419896u, address, netmask, gateway, options);
if (result.IsOk)
{
    Console.WriteLine($"set-IPv4: ok");
}
else
{
    Console.WriteLine($"set-IPv4: error {result.ErrorValue}");
}

var result = SetIPv4(controller, address, netmask, gateway, options);
if (result.IsOk)
{
    Console.WriteLine($"set-IPv4: ok");
}
else
{
    Console.WriteLine($"set-IPv4: error {result.ErrorValue}");
}

VB.NET

Dim controller As New CBuilder(405419896UI).
                      WithEndPoint(IPEndPoint.Parse("192.168.1.100:60000")).
                      WithProtocol("udp").
                      Build()

Dim address = IPAddress.Parse("192.168.1.100")
Dim netmask = IPAddress.Parse("255.255.255.0")
Dim gateway = IPAddress.Parse("192.168.1.1")
Dim options As New OptionsBuilder().WithTimeout(1250).build()

Dim result = SetIPv4(405419896UI, address, netmask, gateway, options)
If result.IsOk Then
    Console.WriteLine($"set-IPv4: ok")
Else
    Console.WriteLine($"set-IPv4: error {result.ErrorValue}")
End If

Dim result = SetIPv4(controller, address, netmask, gateway, options)
If result.IsOk Then
    Console.WriteLine($"set-IPv4: ok")
Else
    Console.WriteLine($"set-IPv4: error {result.ErrorValue}")
End If

Notes

  1. The controller does not respond to the request so in the absence of other errors a sent request is deemed successful.