mokr.network.event

Module Contents

Classes

NetworkEventManager

This class manages a collection of dictionaries used by

class mokr.network.event.NetworkEventManager

This class manages a collection of dictionaries used by mokr.network.NetworkManager to track active event status as events can be received in multiple different orders.

See mokr.network.NetworkManager for more information.

forget(network_id: str) → None

Remove data for the given network_id from all mappings.

Parameters:

network_id (str) – Request network identifier.

response_extra_info(network_id: str) → list[dict]

Get stored response extraInfo for given network_id.

Parameters:

network_id (str) – Request network identifier.

Returns:

List of extraInfo events as dictionaries.

Return type:

list[dict]

queued_redirect_info(fetch_id: str) → list[dict]

Get stored redirect info for given fetch_id.

Parameters:

fetch_id (str) – Request fetch identifier.

Returns:

List of redirect info as dictionaries.

Return type:

list[dict]

queue_redirect_info(fetch_id: str, redirect_info: list[dict]) → None

Store redirect info under a given fetch_id.

Parameters:

• fetch_id (str) – Request fetch identifier.

• redirect_info (list[dict]) – Redirect info data.

take_queued_redirect_info(fetch_id: str) → list[dict]

Remove and return redirect info stored under given fetch_id.

Parameters:

fetch_id (str) – Request fetch identifier.

Returns:

Redirect info data.

Return type:

list[dict]

get_in_flight_requests_count() → int

Get the number of active requests (not resolved).

Returns:

Number of active requests.

Return type:

int

store_request_will_be_sent(network_id: str, event: dict) → None

Store a requestWillBeSent event under given network_id.

Parameters:

• network_id (str) – Request network identifier.

• event (dict) – The requestWillBeSent event received.

get_request_will_be_sent(network_id: str) → dict

Get requestWillBeSent event stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

Returns:

The stored requestWillBeSent under given network_id.

Return type:

dict

forget_request_will_be_sent(network_id: str) → None

Remove requestWillBeSent stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

get_request_paused(network_id: str) → dict

Get requestPaused event stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

Returns:

The stored requestPaused under given network_id.

Return type:

dict

forget_request_paused(network_id: str) → None

Remove requestPaused stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

store_request_paused(network_id: str, event: dict) → None

Store a requestPaused event under given network_id.

Parameters:

• network_id (str) – Request network identifier.

• event (dict) – The requestPaused event received.

get_request(network_id: str) → mokr.network.request.Request

Get mokr.network.Request stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

Returns:

The stored mokr.network.Request under given network_id.

Return type:

dict

store_request(network_id: str, request: mokr.network.request.Request) → None

Store a mokr.network.Request under given network_id.

Parameters:

• network_id (str) – Request network identifier.

• request (Request) – The mokr.network.Request received.

forget_request(network_id: str) → None

Remove mokr.network.Request stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

get_queued_event_group(network_id: str) → dict

Get responseReceivedEvent event stored under given network_id.

Parameters:

network_id (str) – Request network identifier.

Returns:

The stored responseReceivedEvent event under given

network_id.

Return type:

dict

queue_event_group(network_id: str, event: dict) → None

Store a responseReceivedEvent event under given network_id.

Parameters:

• network_id (str) – Request network identifier.

• event (dict) – The responseReceivedEvent received.

forget_queued_event_group(network_id: str) → None

Remove responseReceivedEvent event stored under given network_id.

Parameters:

network_id (str) – Request network identifier.