HTTP server application that handles incoming HTTP requests with the correct URL format by returning a document of the appropriate size. More...
Methods | |
| Client.Identifiers.Get | |
| Returns the list of known identifiers of HTTP clients which made a connection to this server. More... | |
| Description.Get | |
| Returns a textual description of the object. | |
| HasSession | |
| Returns whether or not a client session exists with the given server-client-identifier. 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.Session.Info.Get clientID | |
| Returns the Layer5.Http.SessionInfo from this session. More... | |
| InitialWindowSize.Get | |
| Gets the initial receive window for the server. More... | |
| InitialWindowSize.Set windowsize | |
| Sets the initial receive window for the server. 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. | |
| Port.Get | |
| Returns the configured TCP port for the HTTP server. More... | |
| Port.Set port | |
| Configures the TCP port on which the HTTP server will listen. More... | |
| RcvWindowScale.Get | |
| Returns the current receive window scale. More... | |
| RcvWindowScale.Set scale | |
| Configures the window scale which will be used for new clients. More... | |
| ReceiveWindow.InitialSize.Get | |
| Gets the initial receive window for the server. More... | |
| ReceiveWindow.InitialSize.Set windowsize | |
| Sets the initial receive window for the server. More... | |
| ReceiveWindow.Scaling.Enable scaling | |
| Enables of disables windowscaling. More... | |
| ReceiveWindow.Scaling.IsEnabled | |
| Returns if window scaling 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 new clients. More... | |
| SessionStorage.Enable | |
| SessionStorage.IsEnabled | |
| 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... | |
| Start | |
| Starts the HTTP server on the configured port with the configured configuration. More... | |
| Status.Get | |
| Returns the HTTP server status. More... | |
| Stop | |
| Stops the HTTP server. More... | |
| Tcp.CongestionAvoidance.Algorithm.Get | |
| Gets the current configured TCP Congestion Avoidance Algorithm for new clients. More... | |
| Tcp.CongestionAvoidance.Algorithm.Set congestionAvoidanceAlgorithm | |
| Selects the TCP Congestion Avoidance Algorithm. 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. | |
| WindowScaling.Enable scaling | |
| Enables of disables windowscaling. More... | |
| WindowScaling.Get | |
| Returns if window scaling is enabled or not. More... | |
HTTP server application that handles incoming HTTP requests with the correct URL format by returning a document of the appropriate size.
| Layer5.Http.Server::Client.Identifiers.Get |
Returns the list of known identifiers of HTTP clients which made a connection to this server.
Returns:
BBhttpS3808538043/BBhttpC4042826775 BBhttpS1545014205/BBhttpC2187284405 BBhttpS856132709/BBhttpC3531898846
| Layer5.Http.Server::HasSession |
Returns whether or not a client session exists with the given server-client-identifier.
Returns:
1
| Layer5.Http.Server::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.Server::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.
| Layer5.Http.Server::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.Server::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.
| Layer5.Http.Server::Http.Session.Info.Get | clientID | ||
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
| clientID | ID of the client which has connected with this server. This ID can be retrieved from the Layer5.Http.Client::ServerClientId.Get method on the HTTPClient. Warning, call Layer5.Http.Server::HasSession to verify that the client session exists, before calling this function. Otherwise, an exception may be thrown. |
| ByteBlower.Exception.API.ConfigError | when the HTTP Server did not setup the given HTTP session (e.g. when the TCP connection failed) |
Returns:
<Layer5.Http.SessionInfo object>
| Layer5.Http.Server::InitialWindowSize.Get |
Gets the initial receive window for the server.
Small windowsizes can decrease the performance of a TCP session. Please use a good size for your configuration and network setup.
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| Layer5.Http.Server::InitialWindowSize.Set | windowsize | ||
Sets the initial receive window for the server.
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.Server::MaximumSegmentSize.Get |
| Layer5.Http.Server::MaximumSegmentSize.Set | size | ||
| Layer5.Http.Server::Port.Get |
| Layer5.Http.Server::Port.Set | port | ||
Configures the TCP port on which the HTTP server will listen.
| port | The TCP port on which the HTTP server will listen for incoming 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.Server::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.Server::RcvWindowScale.Set | scale | ||
Configures the window scale which will be used for new clients.
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.
| scale | Integer (0-8), which is used for bitwise shifting. |
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an integer |
| Layer5.Http.Server::ReceiveWindow.InitialSize.Get |
Gets the initial receive window for the server.
Small windowsizes can decrease the performance of a TCP session. Please use a good size for your configuration and network setup.
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an Integer |
| Layer5.Http.Server::ReceiveWindow.InitialSize.Set | windowsize | ||
Sets the initial receive window for the server.
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.Server::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 >0 ) or disable ( false or 0 ) windowscaling. Following values can be used: |
| 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.Server::ReceiveWindow.Scaling.IsEnabled |
Returns if window scaling 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.Server::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.Server::ReceiveWindow.Scaling.Value.Set | scale | ||
Configures the window scale which will be used for new clients.
This must be done before requesting a page from a client, because this option is negotiated at the beginning of the TCP session.
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.
| scale | Integer (0-8), which is used for bitwise shifting. |
| ByteBlower.Exception.InvalidValue.Integer | when the value is not an integer |
| Layer5.Http.Server::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.Server::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.Server::Start |
| Layer5.Http.Server::Status.Get |
Returns the HTTP server status.
Before starting the HTTP server:
{stopped} After starting the HTTP server:
{running}
| Layer5.Http.Server::Stop |
| Layer5.Http.Server::Tcp.CongestionAvoidance.Algorithm.Get |
Gets the current configured TCP Congestion Avoidance Algorithm for new clients.
Returns:
sack
| Layer5.Http.Server::Tcp.CongestionAvoidance.Algorithm.Set | congestionAvoidanceAlgorithm | ||
Selects the TCP Congestion Avoidance Algorithm.
Selects the TCP Congestion Avoidance Algorithm which will be used for new clients. This must be selected before requesting a page from a client, because for some algorithms, the congestion avoidance support is negotiated a the beginning of the TCP session.
| congestionAvoidanceAlgorithm | Congestion Avoidance Algorithm to configure.
|
| <tcl_error> | Failed to parse enumerator: 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.Server::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.Server::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.
| Layer5.Http.Server::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.Server::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.
| Layer5.Http.Server::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 >0 ) or disable ( false or 0 ) windowscaling. Following values can be used: |
| 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.Server::WindowScaling.Get |
Returns if window scaling 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
