package charrua-client

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

charrua-client
- Dhcp_client
charrua-client.lwt
- Dhcp_client_lwt
  - Make
    
    Net
    
    Random
charrua-client.mirage
- Dhcp_client_mirage
  - Make
    
    Network
    
    Random
- Dhcp_ipv4
  - Make
    
    Arp
    
    E
    
    Network
    
    R

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module Random : Mirage_random.S

module Time : Mirage_time.S

module Net : Mirage_net.S

Signature

type lease = Dhcp_wire.pkt

type t = lease Lwt_stream.t

val connect : 
  ?renew:bool ->
  ?xid:Cstruct.uint32 ->
  ?requests:Dhcp_wire.option_code list ->
  Net.t ->
  t Lwt.t

connect renew ~xid requests net starts a DHCP client communicating over the network interface net. The client will attempt to get a DHCP lease at least once, and will return any leases obtained in the stream returned by connect. If renew is true, which it is by default, the client will attempt to renew the lease according to the logic in RFC2131. If renew is false, the client will cancel its listener and end the stream once the first lease has been obtained.