Flow Stream

Field Documentation

Field Documentation

Field Documentation

Initialize flow stream attributes.

See NT_FlowOpen_Attr for further description

Parameters

attr	Pointer to the attributes structure

Referenced by taskReceiverMiss().

Set adapter number attribute.

Parameters

attr	Pointer to the attributes structure
adapterNo	Adapter number the stream should be associated to

Referenced by taskReceiverMiss().

Return the adapter number attribute.

See NT_FlowOpen_Attr for further description

Returns

The adapter number attribute

Set flow stream flags.

Currently no flags are defined so calls of this function shall be avoided

Parameters

attr	Pointer to attriute structure
flags	Flow stream flags

Get flow stream flags.

Parameters

attr	Pointer to attriute structure

Returns

Flow stream flags

Opens a flow programming stream and returns a stream handle.

This function opens a flow stream which is used for fast programming of the flow matcher present on adapters that support the flow matching feature. A flow stream should only be opened after all relevant NTPL statements configuring the flow matcher has been executed.

The default sequence for opening a flow stream is:

NtFlowAttr_t attr;

NT_FlowOpenAttrInit(&attr);

NT_FlowOpenAttrSetAdapterNo(&attr, adapter_no);

int status = NT_FlowOpen_Attr(&_stream, "name", &attr);

Parameters

[out]	hStream	Reference to the NtFlowStream_t stream pointer
[in]	name	Name of the stream
[in]	attr	Pointer to the flow stream attributes

Referenced by taskReceiverMiss().

Closes a flow stream.

This function closes and frees resources belonging to a flow stream

Parameters

[in]

hStream

Flow stream handle to be closed

Return values

NT_SUCCESS	Success
!=NT_SUCCESS	Error - use NT_ExplainError for an error description

Referenced by taskReceiverMiss().

Programs a flow into an adapter.

This function is used to program flows into the adapter associated with the stream handle. The flow data must be written into the NtFlow_t structure by the caller before calling this function.

Returns NT_ERROR_INVALID_PARAMETER if NtFlow_t:

• tau = 1 and gfi = 0
• overwrite is set and any of 7 most significant bit in color is set
• overwrite is not set but streamId is different from 0

Parameters

[in]	hStream	The flow stream handle obtained in NT_FlowOpen_Attr
[in]	flow	Pointer to the flow data structure
[in]	timeout	Timeout in ms before failing to program the flow (-1 = retry indefinitely)

Return values

NT_SUCCESS	The flow was successfully programmed
!=NT_SUCCESS	Error - use NT_ExplainError for an error description

Referenced by taskReceiverMiss().

Read a flow information record.

This function will attempt to read a flow information record. If a record is available in the stream it will be returned in the record pointed to by "info".

Parameters

[in]	hStream	The flow stream handle obtained in NT_FlowOpen_Attr
[out]	info	Pointer to flow info structure the record is returned in
[in]	timeout	Timeout in ms before failing to program the flow (-1 = retry indefinitely)

Return values

NT_SUCCESS	A flow information record was successfully read
!=NT_SUCCESS	Error - use NT_ExplainError for an error description

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Read a flow status record.

This function will attempt to read a flow status record. A status record is an async result response for an NT_FlowWrite. If a record is available in the stream it will be returned in the record pointed to by "status".

There are 5 types of status records:

LearnDone which signals a succesful flow program operation

LearnFail which signals an unsuccesful flow program operation

LearnIgnore which signals an ignored flow program operation (flow already exists)

UnlearnDone which signals a succesful flow unlearn operation

UnlearnIgnore which signals an ignored flow unlearn operation (flow doesn't exists)

Generation of status records can be enabled/disabled individually in ntservice.ini

Parameters

[in]	hStream	The flow stream handle obtained in NT_FlowOpen_Attr
[out]	status	Pointer to flow status structure the record is returned in

Return values

NT_SUCCESS	A flow status record was successfully read
NT_STATUS_TRYAGAIN	No flow status records available at this time
!=NT_SUCCESS	Error - use NT_ExplainError for an error description

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Definition at line 125 of file stream_flow.h.

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Definition at line 126 of file stream_flow.h.

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Definition at line 127 of file stream_flow.h.

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Definition at line 128 of file stream_flow.h.

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Definition at line 129 of file stream_flow.h.

Referenced by anonymous_namespace{flowmatch_example_receiver.cpp}::printFlowStreamInfo().

Flow stream handle

Definition at line 71 of file stream_flow.h.

Flow programming structure.

This structure is used when programming flows with the NT_FlowWrite function.

Flow information structure.

This structure contains state for a particular flow. If flow programming had the gfi bit set, the flow information structure is returned on the flow stream when the flow is terminated or timed out.

Flow status structure.

This structure contains the status for a particular flow (Un-)learning operation. A series of flags indicates whether the operation was successful or not.