API: Hiding the complexity

In the previous (  📄 Timing and automation ) section, we explain the different timestamps for TCP and HTTP in ByteBlower. In this section, we explain the best way to use this with the ByteBlower API.

The T1, T2, and T3 values can be retrieved from the HTTP.SessionInfo object. This real-time status object should always be refreshed first. It then takes a snapshot from the ByteBlower server and makes sure you get the latest timestamp values. The API calls are:

• T1.Get
• T2.Get
• T3.Get

Because the meaning of the server values T1, T2, and T3 are different in different situations, using them is error-prone. To hide this complexity, the ByteBlower API offers more intuitive wrapper methods around these values. The wrappers are:

• Time.Request.Start.Get
• Time.Request.Packet.First.Get
• Time.Request.Packet.Last.Get
• Time.Response.Start.Get
• Time.Response.Packet.First.Get
• Time.Response.Packet.First.Get
• Time.Data.Packet.First.Get
• Time.Data.Packet.Last.Get

Both the availability of the result and the result value of these calls still depend on the situation (GET or PUT, client or server). Their values are explained in the tables below:

The most common use case for the timestamps and events is calculating the average throughput. 

Luckily there is an average throughput API call:

• AverageThroughput.Get

This value is calculated using the first and last data packet timestamps, or in other words: