1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
#
# Copyright (C) 2007-2015 CEA/DAM
# Copyright (C) 2015 Stephane Thiell <sthiell@stanford.edu>
#
# This file is part of ClusterShell.
#
# ClusterShell is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# ClusterShell is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with ClusterShell; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""
ClusterShell Event handling.
This module contains the base class **EventHandler** which defines a simple
interface through methods to handle events coming from ClusterShell I/O Engine
clients. Events are generated by Worker, EngineTimer or EnginePort objects.
"""
class EventHandler(object):
"""ClusterShell EventHandler interface.
Derived class should implement the following methods to listen for Worker,
EngineTimer or EnginePort chosen events.
"""
def ev_start(self, worker):
"""
Called to indicate that a worker has just started.
:param worker: :class:`.Worker` object
"""
def ev_pickup(self, worker):
"""
Called to indicate that a worker command for a specific node (or key)
has just started. Called for each node.
:param worker: :class:`.Worker` object
Available worker attributes:
* :attr:`.Worker.current_node` - node (or key)
"""
def ev_read(self, worker):
"""
Called to indicate that a worker has data to read from a specific
node (or key).
:param worker: :class:`.Worker` object
Available worker attributes:
* :attr:`.Worker.current_node` - node (or key)
* :attr:`.Worker.current_msg` - read message
"""
def ev_error(self, worker):
"""
Called to indicate that a worker has error to read on stderr from
a specific node (or key).
:param worker: :class:`.Worker` object
Available worker attributes:
* :attr:`.Worker.current_node` - node (or key)
* :attr:`.Worker.current_errmsg` - read error message
"""
def ev_written(self, worker, node, sname, size):
"""
Called to indicate that some writing has been done by the worker to a
node on a given stream. This event is only generated when ``write()``
is previously called on the worker.
This handler may be called very often depending on the number of target
nodes, the amount of data to write and the block size used by the
worker.
Note: up to ClusterShell 1.6, this event handler wasn't implemented. To
properly handle ev_written after 1.6, the method signature must consist
of the following parameters:
:param worker: :class:`.Worker` object
:param node: node (or) key
:param sname: stream name
:param size: amount of bytes that has just been written to node/stream
associated with this event
"""
def ev_hup(self, worker):
"""
Called to indicate that a worker command for a specific node (or key)
has just finished. Called for each node.
:param worker: :class:`.Worker` object
Available worker attributes:
* :attr:`.Worker.current_node` - node (or key)
* :attr:`.Worker.current_rc` - command return code
"""
def ev_timeout(self, worker):
"""
Called to indicate that a worker has timed out (worker timeout only).
:param worker: :class:`.Worker` object
"""
def ev_close(self, worker):
"""
Called to indicate that a worker has just finished (it may already
have failed on timeout).
:param worker: :class:`.Worker` object
"""
def ev_msg(self, port, msg):
"""
Called to indicate that a message has been received on an EnginePort.
Used to deliver messages reliably between tasks.
:param port: EnginePort object on which a message has been received
:param msg: the message object received
"""
def ev_timer(self, timer):
"""
Called to indicate that a timer is firing.
:param timer: :class:`.EngineTimer` object that is firing
"""
def _ev_routing(self, worker, arg):
"""
Routing event (private). Called to indicate that a (meta)worker has just
updated one of its route path. You can safely ignore this event.
"""
|
