Layer5.Http.SessionInfo Class Reference

Class containing the info about the HTTPSession. More...

Methods
	Description.Get
	Returns a textual description of the object.
	ErrorMessage.Get
	Returns the error message. More...
	Parent.Get
	Returns the parent object.
	Refresh
	Refresh the info. More...
	Request.Method.Get
	Returns the http request method of the session. More...
	Request.Status.Get
	Returns the status of the HTTP request. More...
	Request.Type.Get
	Returns the request type ( Duration or Size ) More...
	Request.Value.Get
	Returns the request value. More...
	Result.Get
	Returns the Layer5.Http.ResultSnapshot for this session. More...
	Result.History.Get
	Returns the Layer5.Http.ResultHistory for this session. More...
	Tcp.Session.Info.Get
	Returns the Layer4.Tcp.SessionInfo from this session. More...

Class overview

Class containing the info about the HTTPSession.

This class represents the session info gather from a HTTP session. It will contain states of the TCP session, Timestamp of received requests average throughputs etc..

Definition at line 16778 of file api.tcl.

Method documentation

Layer5.Http.SessionInfo::ErrorMessage.Get

Returns the error message.

When the request status is "Error" then extra information can be obtained with this method.

Returns

The error message string

Example

$httpSessionInfo ErrorMessage.Get

Returns:

"TCP connection attempt timed out" 

Definition at line 16797 of file api.tcl.

Layer5.Http.SessionInfo::Refresh

Refresh the info.

Only when executing this method the values are updated

Example

$httpSessionInfo Refresh

Definition at line 16814 of file api.tcl.

Layer5.Http.SessionInfo::Request.Method.Get

Returns the http request method of the session.

Possible values are:

• GET
• PUT

Returns

The request method used in this session

Example

retrieve the httpsession info from the httpClient

set httpClientSessionInfo [ $httpClient Http.Session.Info.Get ]

Returns:

<Layer5::Http::SessionInfo object> 

Get the role of the session

$httpClientSessionInfo RequestMethod.Get

Returns:

GET 

retrieve the httpsession info from the httpServer

set httpServerSessionInfo [ $httpServer Http.Session.Info.Get [$httpClient ServerClientId.Get] ]

Returns:

<Layer5::Http::SessionInfo object> 

Get the role of this session

$httpServerSessionInfo RequestMethod.Get

Returns:

GET 

Definition at line 16828 of file api.tcl.

Layer5.Http.SessionInfo::Request.Status.Get

Returns the status of the HTTP request.

Returns

configuration

initial state in which the configuration takes place

scheduled

during the initial time to wait of a scheduled request

connecting

while trying to establish a connection

running

while the connection is established and before http request has completed

finished

after the http request has completed

stopped

after the user stopped the request

error

if an error occurred while trying to connect or while running

Example

$httpSessionInfo Request.Status.Get

Returns:

running 

Definition at line 16840 of file api.tcl.

Layer5.Http.SessionInfo::Request.Type.Get

Returns the request type ( Duration or Size )

Possible values are:

• Duration
• Size

Returns

request Type

Example

$httpSessionInfo Request.Type.Get

Returns:

Duration 

Definition at line 16854 of file api.tcl.

Layer5.Http.SessionInfo::Request.Value.Get

Returns the request value.

In case of duration based session it returns the duration that was requested by the httpClient. For Size it returns the requested payload size

Returns

Request Value

Example

$httpSessionInfo Request.Value.Get

Returns:

10000000000 

Definition at line 16868 of file api.tcl.

Layer5.Http.SessionInfo::Result.Get

Returns the Layer5.Http.ResultSnapshot for this session.

The snapshot contains byte counters and time values.

Returns

Layer5.Http.ResultSnapshot

Example

$httpSessionInfo Result.Get

Returns:

<Layer5.Http.ResultSnapshot object> 

Definition at line 16882 of file api.tcl.

Layer5.Http.SessionInfo::Result.History.Get

Returns the Layer5.Http.ResultHistory for this session.

The history contains a list of snapshots taken at one second intervals. To update the history use the Refresh function.

Returns

Layer5.Http.ResultHistory

Example

$httpSessionInfo Result.History.Get

Returns:

<Layer5.Http.ResultHistory object> 

Definition at line 16896 of file api.tcl.

Layer5.Http.SessionInfo::Tcp.Session.Info.Get

Returns the Layer4.Tcp.SessionInfo from this session.

The TcpSessionInfo contains information about the Tcp underlying session.

Returns

Layer4.Tcp.SessionInfo

Example

$httpSessionInfo Tcp.Session.Info.Get

Returns:

<Layer4.Tcp.SessionInfo object> 

Definition at line 16910 of file api.tcl.