mirror of
https://github.com/xcat2/confluent.git
synced 2025-01-18 21:53:18 +00:00
36 lines
1.6 KiB
Python
36 lines
1.6 KiB
Python
class ConsoleEvent(object):
|
|
"""This represents a number of specific events to be sent between
|
|
consoleserver and console objects. Disconnect indicates that the console
|
|
object has lost connection. The response to this will be to dispose of the
|
|
Console object and try to request a new one, rather than requesting
|
|
reconnect or anything like that. Break is a serial break."""
|
|
Disconnect, Break = range(2)
|
|
|
|
class Console(object):
|
|
"""This is the class defining the interface a console plugin must return
|
|
for the _console/session element"""
|
|
def __init__(self, node, config):
|
|
raise NotImplementedException("Subclassing required")
|
|
|
|
def connect(self, callback):
|
|
raise NotImplementedException("Subclassing required")
|
|
|
|
def write(self, data):
|
|
raise NotImplementedException("Subclassing required")
|
|
|
|
def wait_for_data(self, timeout=600):
|
|
raise NotImplementedException("Subclassing required")
|
|
|
|
def ping(self):
|
|
"""This function is a hint to the console plugin that now would be a
|
|
nice time to assess health of console connection. Plugins that see
|
|
a use for this should be periodically doing this on their own for
|
|
logging and such, this provides a hint that a user has taken an
|
|
explicit interest in the console output. In my experience, this
|
|
correlates with some conditions that may suggest a loss of console
|
|
as well, so consoles can schedule a health check to run at this time.
|
|
No return is expected, any error condition can be reported by sending
|
|
ConsoleEvent.Disconnect, just like normal."""
|
|
pass
|
|
|