pyrtma.web_manager.WebMessageManager
- class WebMessageManager(host='', port=0, mm_ip='127.0.0.1:7111', loglevel=30, key=None, cert=None)[source]
Bases:
WebsocketServer
WebMessageManager class
WebMessageManager class
- Parameters:
host (str, optional) – IP for WebMessageManager to listen for connections. Defaults to “” (any local IP).
port (int, optional) – Port for WebMessageManager to bind to. Defaults to 0.
mm_ip (str, optional) – Address for RTMA MessageManager. Defaults to “127.0.0.1:7111”.
loglevel (int, optional) – Loging level. Defaults to logging.WARNING.
key (optional) – Path to SSL key. Defaults to None.
cert (optional) – Path to SSL cert. Defaults to None.
Methods
allow_new_connections
client_left
Called to clean up an individual request.
deny_new_connections
disconnect_clients_abruptly
disconnect_clients_gracefully
Return socket file number.
Finish one request by instantiating RequestHandlerClass.
Get the request and client address from the socket.
Handle an error gracefully.
Handle one request, possibly blocking.
Called if no new request arrives within self.timeout.
handler_to_client
message_received
new_client
Start a new thread to process the request.
Same as in BaseServer but as a thread.
run_forever
send_message
send_message_to_all
Handle one request at a time until shutdown.
Called by constructor to activate the server.
Called by constructor to bind the socket.
Called to clean-up the server.
Called by the serve_forever() loop.
set_fn_client_left
set_fn_message_received
set_fn_new_client
Stops the serve_forever loop.
shutdown_abruptly
shutdown_gracefully
Called to shutdown and close an individual request.
Verify the request.
Attributes
address_family
allow_reuse_address
block_on_close
daemon_threads
request_queue_size
socket_type
timeout
- close_request(request)
Called to clean up an individual request.
- fileno()
Return socket file number.
Interface required by selector.
- finish_request(request, client_address)
Finish one request by instantiating RequestHandlerClass.
- get_request()
Get the request and client address from the socket.
May be overridden.
- handle_error(request, client_address)
Handle an error gracefully. May be overridden.
The default is to print a traceback and continue.
- handle_request()
Handle one request, possibly blocking.
Respects self.timeout.
- handle_timeout()
Called if no new request arrives within self.timeout.
Overridden by ForkingMixIn.
- process_request(request, client_address)
Start a new thread to process the request.
- process_request_thread(request, client_address)
Same as in BaseServer but as a thread.
In addition, exception handling is done here.
- serve_forever(poll_interval=0.5)
Handle one request at a time until shutdown.
Polls for shutdown every poll_interval seconds. Ignores self.timeout. If you need to do periodic tasks, do them in another thread.
- server_activate()
Called by constructor to activate the server.
May be overridden.
- server_bind()
Called by constructor to bind the socket.
May be overridden.
- server_close()
Called to clean-up the server.
May be overridden.
- service_actions()
Called by the serve_forever() loop.
May be overridden by a subclass / Mixin to implement any code that needs to be run during the loop.
- shutdown()
Stops the serve_forever loop.
Blocks until the loop has finished. This must be called while serve_forever() is running in another thread, or it will deadlock.
- shutdown_request(request)
Called to shutdown and close an individual request.
- verify_request(request, client_address)
Verify the request. May be overridden.
Return True if we should proceed with this request.