Initializes the reliable.io library runtime. This should be called before any additional functions in this library. Throws an IOException on failure.

Terminates the reliable.io library runtime. This should be called only after all other library functions terminate.

Specifies the logging behavior of reliable.io. Note, this logging behavior is called from C calls to printf and therefore might interfere with the Haskell runtime (such as putStrLn).

Set the reliable.io LogLevel. The default is LogLevel'None.

An EndpointConfig is a write-only opaque datatype that is used to define the settings for creating an Endpoint.

The default EndpointConfig. This uses sensible defaults for the library (as opposed to being zero-initialized, for example).

Sets the name of the endpoint. This is usually not relevant, except when setting the log level to be more than LogLevel'None.

Sets the maximum packet size for the endpoint. This will allow the API to know when to throw an error when the packet being sent is too big. The packet size is purely application specific, but may be useful for making sure that your data sizes don't grow too large during development. The default value for this is 16KB.

Sets the fragmentation limit for this endpoint. The fragmentation limit is the size in bytes for a packet where it will be split into multiple fragments. This need not be maxPacketSize / maxNumFragments, but that is usually a sensible choice. The default value is 1KB.

Sets the fragment size for this endpoint. The fragment size determines the size in bytes of each fragment. This need not be the same as the fragmentation limit, although that is certainly a sensible choice. The default for this value is 1KB.

Sets the number of fragments per packet in this endpoint. This is only to make sure that the endpoint has enough buffer space provisioned for incoming packets. Default for this value is 16, and the maximum value is 256.

Sets the number of packets for which to store received sequence numbers. The default value is 256.

Sets the maximum number of packets for which to store sent packet info. This number reflects the largest number of packets we expect to be in flight at any given time, in order to properly ack them upon receipt of some other endpoint's packets. Also useful for properly computing bandwidth of the endpoint. Default value is 256.

Sets the maximum number of packets for which to store received packet info. Useful for properly acking packets and for accurately computing bandwidth of the endpoint. Default value is 256.

Sets the maximum number of in flight packet fragments that we can store in order to properly recreate the packets upon receipt. This buffer is used to process out of order and dropped packets, as fragments from a packet may not arrive contiguously. Default value is 64.

Sets the round trip time smoothing factor. This is purely for diagnostic purposes when determining what the round trip time is for this endpoint. Smaller numbers will vary the RTT measurement more slowly. Default value is 0.0025f.

Sets the packet loss smoothing factor. This is purely for diagnostic purposes when determining what the packet loss rate is for this endpoint. Smaller numbers will vary the packet loss measurement more slowly. Default value is 0.1f.

Sets the bandwidth smoothing factor. This is purely for diagnostic purposes when determining what the bandwidth is from this endpoint. Smaller numbers will vary the bandwidth measurement more slowly. Default value is 0.1f.

Endpoints support two packet types, either IPV4 or IPV6.

Sets the packet type for this endpoint, which determines the header size that the library needs to allocate in order to properly keep track of the packets.

Function used by an Endpoint to send packet fragments over the unreliable data channel. One use case would be to have the given data sent to a UDP socket.

A user function supplied to an Endpoint that handles reassembled packets once they've been received.

An Endpoint is the main datatype of the reliable.io library. Two endpoints (usually, but not exclusively) on separate hosts represent a connection over an unreliable network, such as the UDP protocol over the internet. The function of an endpoint is to provide a way to administer traffic to the corresponding receiver. It is not responsible for performing the actual sending and receiving of data.

Endpoints provide two main services:

1. Breaking down a large packet into fragments, each of which is a predetermined size.
2. Assembling a sequence of fragments from a corresponding endpoint.
3. Notifying the user when a packet has been received (ack'd) by the corresponding endpoint.

Packets to be disassembled into fragments and transmitted are passed to the endpoint via the sendPacket function. Fragments that are received from the corresponding endpoint and should be reassmbled are passed to the endpoint via the receivePacket function. These functions only queue the data for processing, but the actual processing of packets only takes place during a call to update.

Additionally, each Endpoint keeps track of the metrics associated with it, providing the user with ways to measure the round trip time for each packet, the bandwidth of the connection, and a measurement of the packet loss.

Creates an Endpoint. The two main callbacks required for each endpoint:

1. A TransmitPacketFunction that is able to send packet fragments to a corresponding Endpoint
2. A ProcessPacketFunction that administers the reassmbled packet from a collection of fragments.

The Double parameter corresponds to the time (in seconds) at which the endpoint is created. This time value is needed to be in the same domain to subsequent calls to update in order to properly calculate metrics.

Destroys an Endpoint and any associated callbacks.

Convenience function that follows the Bracket pattern for encapsulating the resource management associated with interfacing with an Endpoint.

Returns the sequence number of the next packet that will be sent from this Endpoint.

sendPacket e p sz will send a packet from Endpoint e with sz bytes whose data resides in the memory pointed to by p. If sz is larger than the fragment limit, the packet will be split into multiple fragments. Each fragment will then be sent via the TransmitPacketFunction passed to createEndpoint. Note, this function does not actually send the packet, and rather queues it for sending during the next call to update.

receivePacket e p sz will add a packet fragment to Endpoint e with sz bytes whose data resides in the memory pointed to by p. Once all of the fragments of a given packet have been received via this function, the Endpoint will pass the reassembled packet to the ProcessPacketFunction passed to createEndpoint. Note, this function does not actually reassemble the packet, and rather queues it for processing during the next call to update.

Returns the list of sequence numbers for the most recently ack'd packets that have been sent from this Endpoint.

Clears the list of sequence numbers for the most recently ack'd packets.

Resets the endpoint, including all metrics about network traffic and any information about ack'd packets.

Performs the work of updating the endpoint. This sends packets, reassembles packets, and identifies any acks received from the corresponding Endpoint. The time passed to this function must be measured in seconds and correspond to the same time domain as createEndpoint.

Returns the measured round trip time for packets sent from this Endpoint.

Returns the measured packet loss for packets sent from this Endpoint.

Bandwidth measurements taken for each Endpoint.

Returns the measured bandwidth for data on this Endpoint.

Counters for metrics that are collected for each Endpoint. These are reset upon calling reset for the given Endpoint.

Returns the counter value associated with the Counter for the given Endpoint.