HTTP client application that may schedule HTTP requests to real webservers or the HTTP server application. More...
Methods | |
| Capture.Clear | |
| Delete any captured data. More... | |
| Capture.Disable | |
| Disable the capture of the HTTPData. More... | |
| Capture.Enable | |
| Enable the capture of the HTTPData. More... | |
| Capture.Get | |
| Return the captured HTTP Data. More... | |
| ClientId.Get | |
| Returns the unique client ID. More... | |
| Description.Get | |
| Returns a textual description of the object. | |
| ErrorMessage.Get | |
| Returns the error message. More... | |
| Finished.Get | |
| Returns whether or not the HTTP session has finished. More... | |
| FlowLabel.Get | |
| Returns the configured "Flow Label" for IPv6 flows. More... | |
| FlowLabel.Set | |
| Configures the flow label for IPv6 flows. More... | |
| HasError | |
| Returns true if an error has occurred. More... | |
| HasSession | |
| Returns whether or not we have a HTTP session. More... | |
| History.Sampling.BufferLength.Get | |
| Gets the default Sampling Buffer Length for the HTTP Session history. More... | |
| History.Sampling.BufferLength.Set | |
| Sets the default Sampling Buffer Length for the HTTP Session history. More... | |
| History.Sampling.Interval.Duration.Get | |
| Gets the default Sampling interval for the HTTP Session history. More... | |
| History.Sampling.Interval.Duration.Set | |
| Sets the default Sampling interval for the HTTP Session history. More... | |
| Http.Method.Get | |
| Returns the used HTTPRequest method. More... | |
| Http.Method.Set | |
| Configures the HTTPRequest method to be used. More... | |
| Http.Session.Info.Get | |
| Returns the Layer5.Http.SessionInfo from this session. More... | |
| InitialWindowSize.Get | |
| Gets the initial receive window for the client. More... | |
| InitialWindowSize.Set windowsize | |
| Sets the initial receive window for the client. More... | |
| Latency.Enable | |
| Local.Port.Get | |
| Returns the TCP the httpclient will use to send its HTTPRequest. More... | |
| Local.Port.Set port | |
| Configure the TCP port for the client to use. More... | |
| MaximumSegmentSize.Get | |
| Returns the configured TCP maximum segment size. More... | |
| MaximumSegmentSize.Set size | |
| Sets the TCP maximum segment size. More... | |
| Parent.Get | |
| Returns the parent object. | |
| RcvWindowScale.Get | |
| Returns the current receive window scale. More... | |
| RcvWindowScale.Set scale | |
| Configures the window scale which will be used for the client. More... | |
| ReceiveWindow.InitialSize.Get | |
| Gets the initial receive window for the client. More... | |
| ReceiveWindow.InitialSize.Set windowsize | |
| Sets the initial receive window for the client. More... | |
| ReceiveWindow.Scaling.Enable scaling | |
| Enables of disables windowscaling. More... | |
| ReceiveWindow.Scaling.IsEnabled | |
| Returns if windowscaling is enabled or not. More... | |
| ReceiveWindow.Scaling.Value.Get | |
| Returns the current receive window scale. More... | |
| ReceiveWindow.Scaling.Value.Set scale | |
| Configures the window scale which will be used for the client. More... | |
| Refresh | |
| Remote.Address.Get | |
| Return the configured destination address. More... | |
| Remote.Address.Set address | |
| Configure the destination address. More... | |
| Remote.Port.Get | |
| Returns the configured destination port. More... | |
| Remote.Port.Set port | |
| Configure the TCP port which the client will use as destination port. More... | |
| Request.Duration.Get | |
| Method which will return the configured HTTP Request duration. More... | |
| Request.Duration.Set requestDuration | |
| Method which will configure a page to send out an HTTP Request to transmit data during a certain time. More... | |
| Request.InitialTimeToWait.Get | |
| Returns the initial time to wait before a scheduled Request starts. More... | |
| Request.InitialTimeToWait.Set timeToWait | |
| Sets the initial time to wait before really requesting a page (for a scheduled Request). More... | |
| Request.Page.Get | |
| Method which will get the HTML page which will be requested. More... | |
| Request.Page.Set pageName | |
| Method which will set the HTML page which will be requested. More... | |
| Request.RateLimit.Get | |
| Method which will return the configured rate-limit of the HTTP traffic. More... | |
| Request.RateLimit.Set rateLimit | |
| Method which will limit the rate of the HTTP traffic to a certain amount.. More... | |
| Request.Size.Get | |
| Method which will return the configured requested pagesize expressed in Bytes. More... | |
| Request.Size.Set requestSize | |
| Method which will configure a page to send out an HTTP Request to request a certain number of Bytes. More... | |
| Request.Start.Type.Get | |
| Returns the current configured Start Type. More... | |
| Request.Start.Type.Set startType | |
| Configures the Start Type of a HTTP Request. More... | |
| Request.Start | |
| Start the current configured HTTP Request. More... | |
| Request.Status.Get | |
| Returns the status of the HTTP request. More... | |
| Request.Stop | |
| This will stop the client. More... | |
| Request.Uri.Get | |
| Returns the requested URI. More... | |
| Request.Uri.Set uri | |
| Method which will set the URI, it contains the complete HTTP URI which will be requested. More... | |
| ServerClientId.Get | |
| This method returns the combination of the server Id ( aka ByteBlower Server Id ) and client Id. More... | |
| ServerId.Get | |
| Returns the unique ByteBlower Server ID. More... | |
| SlowStartThreshold.Get | |
| Returns the initial slow-start threshold value used by TCP. More... | |
| SlowStartThreshold.Set ssthresh | |
| Set the initial slow-start threshold value used by TCP. More... | |
| Tcp.CongestionAvoidance.Algorithm.Get | |
| Gets the current configured TCP Congestion Avoidance Algorithm. More... | |
| Tcp.CongestionAvoidance.Algorithm.Set congestionAvoidanceAlgorithm | |
| Selects the used TCP Congestion Avoidance Algorithm (TCAA). More... | |
| Tcp.History.Sampling.BufferLength.Get | |
| Gets the default Sampling Buffer Length for the TCP Session history. More... | |
| Tcp.History.Sampling.BufferLength.Set | |
| Sets the default Sampling Buffer Length for the TCP Session history. More... | |
| Tcp.History.Sampling.Interval.Duration.Get | |
| Gets the default Sampling interval for the TCP Session history. More... | |
| Tcp.History.Sampling.Interval.Duration.Set | |
| Sets the default Sampling interval for the TCP Session history. More... | |
| Tcp.Prague.Enable | |
| Enables TCP Prague congestion control for L4S. | |
| Tcp.Prague.IsEnabled | |
| Returns if TCP Prague congestion control is enabled or not. | |
| TypeOfService.Get | |
| Retrieves the 'Type Of Service' or 'Traffic Class' configuration of the IP layer. More... | |
| TypeOfService.Set | |
| Configures the 'Type Of Service' or 'Traffic Class' used at the IP layer. More... | |
| WaitUntilConnected Timeout | |
| Waits until connection is established or timeout has expired. More... | |
| WaitUntilFinished Timeout | |
| Waits until request is finished or timeout has expired. More... | |
| WindowScaling.Enable scaling | |
| Enables of disables windowscaling. More... | |
| WindowScaling.Get | |
| Returns if windowscaling is enabled or not. More... | |
HTTP client application that may schedule HTTP requests to real webservers or the HTTP server application.
Using this class, you can simulate TCP (Transmission Control Protocol) traffic The TCP is simulated by a HTML request to the HTTPServer. This is the HttpClient that will perform the GET or the PUT. This request can be sent to the HttpServerObject (Layer5.Http.Server) or even a real HTTPServer.
| Layer5.Http.Client::Capture.Clear |
| Layer5.Http.Client::Capture.Disable |
| Layer5.Http.Client::Capture.Enable |
| Layer5.Http.Client::Capture.Get |
| Layer5.Http.Client::ClientId.Get |
Returns the unique client ID.
Each client has a unique ID so that information about the same connection can be requested on a HTTP server object. This method returns the unique ClientID for this HTTP client.
Returns:
BBhttpC800286629
| Layer5.Http.Client::ErrorMessage.Get |
| Layer5.Http.Client::Finished.Get |
| Layer5.Http.Client::FlowLabel.Get |
| Layer5.Http.Client::FlowLabel.Set |
| Layer5.Http.Client::HasError |
| Layer5.Http.Client::HasSession |
| Layer5.Http.Client::History.Sampling.BufferLength.Get |
Gets the default Sampling Buffer Length for the HTTP Session history.
The history on the HTTP Session History object can be configured when the session is started. This method allows to configure the HTTP Session History before the request is started and has thus the advantage not to invalidate previous history items.
Returns:
6
| Layer5.Http.Client::History.Sampling.BufferLength.Set |
Sets the default Sampling Buffer Length for the HTTP Session history.
The history on the HTTP Session History object can be configured when the session is started. This method allows to configure the HTTP Session History before the request is started and has thus the advantage not to invalidate previous history items.
This function is only allowed when the HTTP Session is not running yet. When the HTTP Session is running, the history must be configured on the HTTP Session object.
| Layer5.Http.Client::History.Sampling.Interval.Duration.Get |
Gets the default Sampling interval for the HTTP Session history.
The history on the HTTP Session History object can be configured when the session is started. This method allows to configure the HTTP Session History before the request is started and has thus the advantage not to invalidate previous history items.
Returns:
1000000000
| Layer5.Http.Client::History.Sampling.Interval.Duration.Set |
Sets the default Sampling interval for the HTTP Session history.
The history on the HTTP Session History object can be configured when the session is started. This method allows to configure the HTTP Session History before the request is started and has thus the advantage not to invalidate previous history items.
This function is only allowed when the HTTP Session is not running yet. When the HTTP Session is running, the history must be configured on the HTTP Session object.
| Layer5.Http.Client::Http.Method.Get |
Returns the used HTTPRequest method.
There are 2 possible values:
Returns:
GET
or in case of a PUT it will return Returns:
PUT
| Layer5.Http.Client::Http.Method.Set |
Configures the HTTPRequest method to be used.
There are 2 possible values:
| <tcl_error> | bad lexical cast: When the value could not be interpreted as a valid HTTPRequestMethod |
or in case of a PUT it will return
| Layer5.Http.Client::Http.Session.Info.Get |
Returns the Layer5.Http.SessionInfo from this session.
The HttpSessionInfo contains all the information of the current session. From state until the counters of received/transmitted bytes
Returns:
<Layer5.Http.SessionInfo object>
| Layer5.Http.Client::InitialWindowSize.Get |
Gets the initial receive window for the client.
Small windowsizes can decrease the performance of a TCP session. Please use a good size for your configuration and network setup.
Returns:
65535
| Layer5.Http.Client::InitialWindowSize.Set | windowsize | ||
Sets the initial receive window for the client.
Small windowsizes can decrease the performance of a TCP session. Please use a good size for your configuration and network setup.
| windowsize | New value of the initial receive window. |
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| Layer5.Http.Client::Local.Port.Get |
| Layer5.Http.Client::Local.Port.Set | port | ||
Configure the TCP port for the client to use.
This method will set the TCP port for the client.
| port | TCP port on which the client will listen or replies and send its requests. |
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| ByteBlower.Exception.InvalidConfig | when the value is not between 1 and 65535 |
| Layer5.Http.Client::MaximumSegmentSize.Get |
| Layer5.Http.Client::MaximumSegmentSize.Set | size | ||
| Layer5.Http.Client::RcvWindowScale.Get |
Returns the current receive window scale.
The TCP window scale option is an option to increase the receive window size allowed in Transmission Control Protocol above its former maximum value of 65,535 bytes. This TCP option, along with several others, is defined in IETF RFC 1323.
Returns:
3
| Layer5.Http.Client::RcvWindowScale.Set | scale | ||
Configures the window scale which will be used for the client.
The TCP window scale option is an option to increase the receive window size allowed in Transmission Control Protocol above its former maximum value of 65,535 bytes. This TCP option, along with several others, is defined in IETF RFC 1323.
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| scale | Integer (0-14), which is used for bitwise shifting. |
| Layer5.Http.Client::ReceiveWindow.InitialSize.Get |
Gets the initial receive window for the client.
Small windowsizes can decrease the performance of a TCP session. Please use a good size for your configuration and network setup.
Returns:
65535
| Layer5.Http.Client::ReceiveWindow.InitialSize.Set | windowsize | ||
Sets the initial receive window for the client.
Small windowsizes can decrease the performance of a TCP session. Please use a good size for your configuration and network setup.
| windowsize | New value of the initial receive window. |
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| Layer5.Http.Client::ReceiveWindow.Scaling.Enable | scaling | ||
Enables of disables windowscaling.
Windowscaling allows windowsizes to grow further than 65,536 bytes. For high speed or high latency links, window scaling should be enabled for a good throughput.
| scaling | Boolean which will enable ( true ) or disable ( false ) windowscaling. |
| ByteBlower.Exception.InvalidValue | when the value is not an integer or true or false |
To enable window scaling
or
To disable window scaling
or
| Layer5.Http.Client::ReceiveWindow.Scaling.IsEnabled |
Returns if windowscaling is enabled or not.
Windowscaling allows windowsizes to grow further than 65,536 bytes. For high speed or high latency links, window scaling should be enabled for a good throughput.
When enabled: Returns:
1
When disabled: Returns:
0
| Layer5.Http.Client::ReceiveWindow.Scaling.Value.Get |
Returns the current receive window scale.
The TCP window scale option is an option to increase the receive window size allowed in Transmission Control Protocol above its former maximum value of 65,535 bytes. This TCP option, along with several others, is defined in IETF RFC 1323.
Returns:
3
| Layer5.Http.Client::ReceiveWindow.Scaling.Value.Set | scale | ||
Configures the window scale which will be used for the client.
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| ByteBlower.Exception.API.ConfigError | when the value is not in the range 0-8 |
| scale | Integer (0-8), which is used for bitwise shifting. |
| Layer5.Http.Client::Remote.Address.Get |
| Layer5.Http.Client::Remote.Address.Set | address | ||
Configure the destination address.
Method to configure the address of the HTTP server which this client will try to contact.
| address | Address of the HTTP server this client will use. |
| Layer5.Http.Client::Remote.Port.Get |
| Layer5.Http.Client::Remote.Port.Set | port | ||
Configure the TCP port which the client will use as destination port.
This method is used to configure the TCP port of the server which the client will try to contact.
| port | TCP port of the HTTP server which the client will try to contact. |
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| ByteBlower.Exception.InvalidConfig | when the value is not between 1 and 65535 |
Configure the client to use port 80 as destination port
| Layer5.Http.Client::Request.Duration.Get |
Method which will return the configured HTTP Request duration.
A HTTP Request page will be configured to request to send data, during a certain time, on a ByteBlower HTTP server.
Get the configured a request duration 1.5 seconds
Returns:
1500000000
| Layer5.Http.Client::Request.Duration.Set | requestDuration | ||
Method which will configure a page to send out an HTTP Request to transmit data during a certain time.
A HTTP Request page will be configured to request to send data, during a certain time, on a ByteBlower HTTP server.
This will prepare a nice TCP traffic test with data transferred over the network until the requested duration has passed.
| requestDuration | The duration of data traffic to send the HTTP Request for. |
| <tcl_error> | bad lexical cast: When the value could not be interpreted as a valid time string |
will configure a request to transfer data during 1.5 seconds
or expressed in nano seconds
| Layer5.Http.Client::Request.InitialTimeToWait.Get |
| Layer5.Http.Client::Request.InitialTimeToWait.Set | timeToWait | ||
Sets the initial time to wait before really requesting a page (for a scheduled Request).
This can be used if you want to start different request on different timestamps.
| timeToWait | Time to wait before the request will be really sent. Units are ns, but can be added. |
| <tcl_error> | bad lexical cast: When the value could not be interpreted as a valid time string |
Initial Time to wait of 60 seconds
Initial Time to wait of 60 seconds expressed in nanoseconds
Initial Time to wait of 60 seconds expressed in minutes
| Layer5.Http.Client::Request.Page.Get |
Method which will get the HTML page which will be requested.
If you are requesting on a ByteBlower HTTP Server, please check Layer5.Http.Client::Request.Size.Set and Layer5.Http.Client::Request.Duration.Set for specialized HTTP Requests
Method which will set the HTML page which will be requested. When Layer5.Http.Client::Request.Start is called, the HTTP Client will send a HTTP Request message for this page and will listen for a response.
A typical use in ByteBlower is a request for a certain size to a ByteBlower HTTP server. e.g. 10000000.html This will give us a nice TCP traffic test with the number of requested Bytes transferred over the network.
Setting the client to request for the page: 100000.html
Returns:
100000.html
| Layer5.Http.Client::Request.Page.Set | pageName | ||
Method which will set the HTML page which will be requested.
If you are requesting on a ByteBlower HTTP Server, please check Layer5.Http.Client::Request.Size.Set and Layer5.Http.Client::Request.Duration.Set for specialized HTTP Requests
Method which will set the HTML page which will be requested. When Layer5.Http.Client::Request.Start is called, the HTTP Client will send a HTTP Request message for this page and will listen for a response.
A typical use in ByteBlower is a request for a certain size to a ByteBlower HTTP server. e.g. 10000000.html This will give us a nice TCP traffic test with the number of requested Bytes transferred over the network.
| pageName | The page to send the HTTP Request for. |
Setting the client to request for the page: 100000.html
| Layer5.Http.Client::Request.RateLimit.Get |
| Layer5.Http.Client::Request.RateLimit.Set | rateLimit | ||
Method which will limit the rate of the HTTP traffic to a certain amount..
| rateLimit | The rate limit, in bytes per second. |
Setting the rate limit to 10 MBytesps
Disable rate limit
| Layer5.Http.Client::Request.Size.Get |
Method which will return the configured requested pagesize expressed in Bytes.
A HTTP Request page will be configured to request for a certain size of data on a ByteBlower HTTP server.
Getting the configured requestsize
Returns:
10000000
| Layer5.Http.Client::Request.Size.Set | requestSize | ||
Method which will configure a page to send out an HTTP Request to request a certain number of Bytes.
A HTTP Request page will be configured to request for a certain size of data on a ByteBlower HTTP server.
This will prepare a nice TCP traffic test with the number of requested Bytes transferred over the network.
| requestSize | The number of Bytes to send the HTTP Request for. |
Setting the requestsize to 10000000 Bytes
| Layer5.Http.Client::Request.Start |
Start the current configured HTTP Request.
The Start Type can be configured using Layer5.Http.Client::Request.Start.Type.Set
Configuring the Request is done using Layer5.Http.Client::Request.Size.Set and Layer5.Http.Client::Request.Duration.Set
| ByteBlower.Exception.API.ConfigError | This exception is thrown when some configurations are incorrect. For example if the RemoteAddress is an IPv6 address and the HTTPClient has a IPv4 address. |
Returns:
BBhttpS72577556/BBhttpC800286629
| Layer5.Http.Client::Request.Start.Type.Get |
Returns the current configured Start Type.
Returns the current configured Start Type for a HTTP Request. There are 2 possible values:
On a httpClient with direct starttype
Returns:
direct
On a httpClient with a scheduled starttype
Returns:
scheduled
| Layer5.Http.Client::Request.Start.Type.Set | startType | ||
Configures the Start Type of a HTTP Request.
Configures the Start Type of a HTTP Request. There are 2 possible values:
| startType | Start Type of the HTTP request. Must be 'direct' or 'scheduled'. |
Setting the startype to direct
Setting the startype to scheduled
use Request.InitialTimeToWait.Set to configure the schedule
| Layer5.Http.Client::Request.Status.Get |
Returns the status of the HTTP request.
Returns:
configuration
| Layer5.Http.Client::Request.Stop |
| Layer5.Http.Client::Request.Uri.Get |
Returns the requested URI.
Returns the URI like it is or will be requested by the client.
Returns:
?
| Layer5.Http.Client::Request.Uri.Set | uri | ||
Method which will set the URI, it contains the complete HTTP URI which will be requested.
When Layer5.Http.Client::Request.Start is called, the HTTP Client will send a HTTP Request message for this page and will listen for a response.
Different from the Layer5.Http.Client::Request.Page.Set method, this method allows you to configure a HTTP Request to external (non-ByteBlower) HTTP servers without adding the 'server-client-id' to the HTTP Request page's path. Configuring the URI will also configure the HTTP Server address and HTTP Server TCP to which the HTTP Request is sent.
| uri | The URI the httpClient must request. |
configure the HTTP Client to send a request to HTTP Server 1.1.1.1, on the default TCP port 80, for page '/test/index.html'
configure the HTTP Client to send a request to HTTP Server 10.10.10.2, on TCP port 8080, for page '/project/index.html'
| Layer5.Http.Client::ServerClientId.Get |
This method returns the combination of the server Id ( aka ByteBlower Server Id ) and client Id.
This returns a combination of the ServerId and the Client Id. This combination will identify a HTTP connection. It is this combination of id's you can use to request the Layer5.Http.SessionInfo on the HTTP server (Layer5.Http.Server::Http.Session.Info.Get)
Returns:
BBhttpS72577556/BBhttpC800286629
| Layer5.Http.Client::ServerId.Get |
Returns the unique ByteBlower Server ID.
Each ByteBlower server has a unique ID. This identifier stays persistant over the lifetime of the ByteBlowerServers ( changed when rebooted ). This serverId together with the clientId identifies a HTTPConnection. By adding those 2 id's together it is unlikely that 2 httpclients each running on a different server end up with the same connection ID.
Returns:
BBhttpS72577556
| Layer5.Http.Client::SlowStartThreshold.Get |
Returns the initial slow-start threshold value used by TCP.
The slow-start threshold indicates when the slow-start phase ends and the congestion avoidance phase starts. Consider increasing this value if you find that TCP takes a long time to reach peak throughput. See RFC 5681 "TCP Congestion Control" for more information on this topic.
Returns:
65535
| Layer5.Http.Client::SlowStartThreshold.Set | ssthresh | ||
Set the initial slow-start threshold value used by TCP.
The slow-start threshold indicates when the slow-start phase ends and the congestion avoidance phase starts. Consider increasing this value if you find that TCP takes a long time to reach peak throughput. See RFC 5681 "TCP Congestion Control" for more information on this topic.
| ssthresh | New value for the slow-start threshold |
| ByteBlower.Exception.InvalidValue | when the value is not a positive integer |
To set slow-start threshold to 1000000
| Layer5.Http.Client::Tcp.CongestionAvoidance.Algorithm.Get |
Gets the current configured TCP Congestion Avoidance Algorithm.
Returns:
sack
| Layer5.Http.Client::Tcp.CongestionAvoidance.Algorithm.Set | congestionAvoidanceAlgorithm | ||
Selects the used TCP Congestion Avoidance Algorithm (TCAA).
This must be selected before requesting the page, because for some algorithms, the congestion avoidance support is negotiated a the beginning of the TCP session.
| congestionAvoidanceAlgorithm | Congestion Avoidance Algorithm to configure. Possible values are:
|
| ByteBlower.Exception.API.ConfigError | Invalid TCP congestion avoidance algorithm: When the value could not be interpreted as a valid TCAA |
Configure NewReno as congestionAvoidance Algorithm
Configure Sack as congestionAvoidance Algorithm
Configure None as congestionAvoidance Algorithm
| Layer5.Http.Client::Tcp.History.Sampling.BufferLength.Get |
Gets the default Sampling Buffer Length for the TCP Session history.
The history on the TCP Session History object can be configured when the session is started. This method allows to configure the TCP Session History before the request is started and has thus the advantage not to invalidate previous history items.
Returns:
6
| Layer5.Http.Client::Tcp.History.Sampling.BufferLength.Set |
Sets the default Sampling Buffer Length for the TCP Session history.
The history on the TCP Session History object can be configured when the session is started. This method allows to configure the TCP Session History before the request is started and has thus the advantage not to invalidate previous history items.
This function is only allowed when the HTTP Session is not running yet. When the HTTP Session is running, the history must be configured on the TCP Session object.
| Layer5.Http.Client::Tcp.History.Sampling.Interval.Duration.Get |
Gets the default Sampling interval for the TCP Session history.
The history on the TCP Session History object can be configured when the session is started. This method allows to configure the TCP Session History before the request is started and has thus the advantage not to invalidate previous history items.
Returns:
1000000000
| Layer5.Http.Client::Tcp.History.Sampling.Interval.Duration.Set |
Sets the default Sampling interval for the TCP Session history.
The history on the TCP Session History object can be configured when the session is started. This method allows to configure the TCP Session History before the request is started and has thus the advantage not to invalidate previous history items.
This function is only allowed when the HTTP Session is not running yet. When the HTTP Session is running, the history must be configured on the TCP Session object.
| Layer5.Http.Client::TypeOfService.Get |
Retrieves the 'Type Of Service' or 'Traffic Class' configuration of the IP layer.
Both IP headers reserve space to for an the expected quality of service(QOS) field. In IPv4 this field is called the 'Type Of Service'. IPv6 uses the term 'Traffic Class'. Despite naming, they are both 8 bits wide. For ease of use, the getter is generic, it is used for both IPv4 and IPv6 layers.
This method returns a number from 0 up to 255. This value represents the the byte used at the IP layer.
| Layer5.Http.Client::TypeOfService.Set |
Configures the 'Type Of Service' or 'Traffic Class' used at the IP layer.
Both IP headers reserve space to specify the expected quality of service(QOS). IPv4 calls this field the 'Type Of Service'. In IPv6 one uses the term 'Traffic Class'. Despite naming, they are both 8 bits wide. For ease of use, the method is generic, it is used for both IPv4 and IPv6 layers. The implementaion will configure the proper header.
The input accepts integers from 0 up to 255. This value will be directly used in byte-sized field at the IP layer. No additional coding is performed.
This method can be called solely during the configuration phase,thus before the parent ByteBlower port is started. Invoking the method at other moments will result in error.
| Layer5.Http.Client::WaitUntilConnected | Timeout | ||
Waits until connection is established or timeout has expired.
Valid states in which this method may be called: scheduled, connecting, running and finished.
Returns true immediately when called from running or finished states.
Returns false if timeout expired before running state was reached.
Throws config error if called from configuration or stopped state.
When called from error state or if error state is reached while waiting then the server-side exception that caused the error state will be rethrown here.
| Timeout | How long we should wait before giving up (and returning false). |
| Layer5.Http.Client::WaitUntilFinished | Timeout | ||
Waits until request is finished or timeout has expired.
Valid states in which this method may be called: scheduled, connecting, running and finished.
Returns true immediately when called from finished state.
Returns false if timeout expired before finished state was reached.
Throws config error if called from configuration or stopped state.
When called from error state or if error state is reached while waiting then the server-side exception that caused the error state will be rethrown here.
| Timeout | How long we should wait before giving up (and returning false). |
| Layer5.Http.Client::WindowScaling.Enable | scaling | ||
Enables of disables windowscaling.
Windowscaling allows windowsizes to grow further than 65,536 bytes. For high speed or high latency links, window scaling should be enabled for a good throughput.
| scaling | Boolean which will enable ( true ) or disable ( false ) windowscaling. |
| ByteBlower.Exception.InvalidValue | when the value is not an integer or true or false |
To enable window scaling
or
To disable window scaling
or
| Layer5.Http.Client::WindowScaling.Get |
Returns if windowscaling is enabled or not.
Windowscaling allows windowsizes to grow further than 65,536 bytes. For high speed or high latency links, window scaling should be enabled for a good throughput.
When enabled: Returns:
1
When disabled: Returns:
0
