ILXTransaction¶

new ILXTransaction(stream)

Since:

BIP-IP TMOS 13.0

Represents a request or response transaction object. When both ILX and HTTP profiles are associated with a Virtual Server all traffic management is done in the context of request and response transactions.

Parameters:

Name	Type	Description
stream	ILXTransaction~reque st \| ILXTransaction~respo nse

Listens to Events:

Example:

 plugin.on('connect', function(flow) {
  flow.client.on('requestStart', function(request) {
    request.setHeader('X-F5-ilxTest', 'successful'); // <----- ILXTransaction request object
  });
  flow.server.on('responseComplete', function(response) {
     response.complete();   // <-------------- ILXTransaction response object
  });
});

Methods¶

complete()¶

Indicates the end of the transaction. This must be called after all headers and data have been sent. The transaction will not be sent to the client or server until ILXTransaction.complete is called.

removeHeader(headerName)¶

Remove headers from the transaction. It is OK to attempt to remove a header that is not in the transaction. The following items may not be removed: keepalive, method, path, query, status, version and uri. Must be called before any data is written to the stream. After the requestStart event is received the plugin may add, remove and modify headers.

Parameters:¶

Name	Type	Description
headerName	string	The name of a header to remove from the transaction

replaceBody()¶

Discard all data received from the client (or server). The plugin can replace the body using ILXFlow.server.write (or ILXFlow.client.write).This can be called after ` <ILXStream.html#event:requestStart>`__

ILXStream#event:requestStart

or ` <ILXStream.html#event:responseStart>`__

ILXStream#event:responseStart

and before ` <#complete>`__

ILXTransaction.complete()

respond()¶

(request ILXTransaction object only) Tells the plugin that it will respond directly to the client. The request will be discarded and not sent to the server. When the requestComplete event is received the plugin may add headers and a body to the response. To send the response to the client the plugin must call ` <#complete>`__

ILXTransaction.complete()

setHeader(name, value)¶

Add or replace a header. Must be called before any data is written to the transaction. After the requestStart event is received the plugin may add, remove and modify headers.

Parameters:¶

Name	Type	Description
name	string	Header name
value	string	Header value

Type Definitions¶

request¶

Type:¶

object

Properties:¶

Name Type Description

params

object

Propertie

s

name:	properties-

Nam e	Typ e	Des cri pti on
ver sio n	str ing	HTT P pro toc ol ver sio n
hea der s	obj ect	An obj ect of hea der s key :va lue pai rs
tru nca ted	str ing	Ind ica tes if the bod y was tru nca ted
met hod	str ing	Req ues t met hod
uri	str ing	Req ues t URI (in clu din g que ry)
pat h	str ing	Pat h por tio n of the URI , may be und efi ned
que ry	str ing	Req ues t que ry por tio n of the URI , may be und efi ned

response¶