Initial commit.
Change-Id: Ia612b44511b19e22a73cb6d4662fc02207af9321
This commit is contained in:
parent
6044080423
commit
b6097dc7ed
8
.gitignore
vendored
Normal file
8
.gitignore
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
*.egg-info
|
||||
*.pyc
|
||||
.tox
|
||||
AUTHORS
|
||||
build/*
|
||||
ChangeLog
|
||||
doc/build/*
|
||||
dist/
|
202
LICENSE
Normal file
202
LICENSE
Normal file
@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
557
gear/__init__.py
Normal file
557
gear/__init__.py
Normal file
@ -0,0 +1,557 @@
|
||||
# Copyright 2013 OpenStack Foundation
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
import struct
|
||||
import socket
|
||||
import threading
|
||||
import select
|
||||
import os
|
||||
import time
|
||||
import logging
|
||||
|
||||
import constants
|
||||
|
||||
PRECEDENCE_NORMAL=0
|
||||
PRECEDENCE_LOW=1
|
||||
PRECEDENCE_HIGH=2
|
||||
|
||||
|
||||
class ConnectionError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class InvalidDataError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class ConfigurationError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class NoConnectedServersError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class UnknownJobError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class Connection(object):
|
||||
log = logging.getLogger("gear.Connection")
|
||||
|
||||
def __init__(self, host, port):
|
||||
self.host = host
|
||||
self.port = port
|
||||
|
||||
self._init()
|
||||
|
||||
def _init(self):
|
||||
self.conn = None
|
||||
self.connected = False
|
||||
self.pending_jobs = []
|
||||
self.related_jobs = {}
|
||||
|
||||
def __repr__(self):
|
||||
return '<gear.Connection 0x%x host: %s port: %s>' % (
|
||||
id(self), self.host, self.port)
|
||||
|
||||
def connect(self):
|
||||
self.log.debug("Connecting to %s port %s" % (self.host, self.port))
|
||||
s = None
|
||||
for res in socket.getaddrinfo(self.host, self.port,
|
||||
socket.AF_UNSPEC, socket.SOCK_STREAM):
|
||||
af, socktype, proto, canonname, sa = res
|
||||
try:
|
||||
s = socket.socket(af, socktype, proto)
|
||||
except socket.error as msg:
|
||||
s = None
|
||||
continue
|
||||
try:
|
||||
s.connect(sa)
|
||||
except socket.error as msg:
|
||||
s.close()
|
||||
s = None
|
||||
continue
|
||||
break
|
||||
if s is None:
|
||||
self.log.debug("Error connecting to %s port %s" % (
|
||||
self.host, self.port))
|
||||
raise ConnectionError("Unable to open socket")
|
||||
self.log.debug("Connected to %s port %s" % (self.host, self.port))
|
||||
self.conn = s
|
||||
self.connected = True
|
||||
|
||||
def disconnect(self):
|
||||
self.log.debug("Disconnected from %s port %s" % (self.host, self.port))
|
||||
self._init()
|
||||
|
||||
def reconnect(self):
|
||||
self.disconnect()
|
||||
self.connect()
|
||||
|
||||
def sendPacket(self, packet):
|
||||
self.conn.send(packet.toBinary())
|
||||
|
||||
def readPacket(self):
|
||||
packet = b''
|
||||
datalen = 0
|
||||
code = None
|
||||
ptype = None
|
||||
while True:
|
||||
c = self.conn.recv(1)
|
||||
if not c:
|
||||
return None
|
||||
packet += c
|
||||
if len(packet) == 12:
|
||||
code, ptype, datalen = struct.unpack('!4sii', packet)
|
||||
elif len(packet) == datalen+12:
|
||||
return Packet(code, ptype, packet[12:], connection=self)
|
||||
|
||||
|
||||
class Packet(object):
|
||||
log = logging.getLogger("gear.Packet")
|
||||
|
||||
def __init__(self, code, ptype, data, connection=None):
|
||||
if code[0] != '\x00':
|
||||
raise InvalidDataError("First byte of packet must be 0")
|
||||
self.code = code
|
||||
self.ptype = ptype
|
||||
self.data = data
|
||||
self.connection = connection
|
||||
|
||||
def __repr__(self):
|
||||
ptype = constants.types.get(self.ptype, 'UNKNOWN')
|
||||
return '<gear.Packet 0x%x type: %s>' % (id(self), ptype)
|
||||
|
||||
def toBinary(self):
|
||||
b = struct.pack('!4sii', self.code, self.ptype, len(self.data))
|
||||
b += self.data
|
||||
return b
|
||||
|
||||
def getArgument(self, index):
|
||||
return self.data.split('\x00')[index]
|
||||
|
||||
def getJob(self):
|
||||
handle = self.getArgument(0)
|
||||
job = self.connection.related_jobs.get(handle)
|
||||
if not job:
|
||||
raise UnknownJobError()
|
||||
return job
|
||||
|
||||
class Client(object):
|
||||
log = logging.getLogger("gear.Client")
|
||||
|
||||
def __init__(self):
|
||||
self.active_connections = []
|
||||
self.inactive_connections = []
|
||||
|
||||
self.connection_index = -1
|
||||
# A lock and notification mechanism to handle not having any
|
||||
# current connections
|
||||
self.connections_condition = threading.Condition()
|
||||
|
||||
# A pipe to wake up the poll loop in case it needs to restart
|
||||
self.wake_read, self.wake_write = os.pipe()
|
||||
|
||||
self.poll_thread = threading.Thread(name="Gearman client poll",
|
||||
target=self._doPollLoop)
|
||||
self.poll_thread.start()
|
||||
self.connect_thread = threading.Thread(name="Gearman client connect",
|
||||
target=self._doConnectLoop)
|
||||
self.connect_thread.start()
|
||||
|
||||
def __repr__(self):
|
||||
return '<gear.Client 0x%x>' % id(self)
|
||||
|
||||
def addServer(self, host, port=4730):
|
||||
"""Add a server to the client's connection pool.
|
||||
|
||||
Any number of Gearman servers may be added to a client. The
|
||||
client will connect to all of them and send jobs to them in a
|
||||
round-robin fashion. When servers are disconnected, the
|
||||
client will automatically remove them from the pool,
|
||||
continuously try to reconnect to them, and return them to the
|
||||
pool when reconnected. New servers may be added at any time.
|
||||
|
||||
This is a non-blocking call that will return regardless of
|
||||
whether the initial connection succeeded. If you need to
|
||||
ensure that a connection is ready before proceeding, see
|
||||
:py:meth:`waitForServer`.
|
||||
|
||||
:arg str host: The hostname or IP address of the server.
|
||||
:arg int port: The port on which the gearman server is listening.
|
||||
"""
|
||||
|
||||
self.log.debug("Adding server %s port %s" % (host, port))
|
||||
|
||||
self.connections_condition.acquire()
|
||||
try:
|
||||
for conn in self.active_connections + self.inactive_connections:
|
||||
if conn.host == host and conn.port == port:
|
||||
raise ConfigurationError("Host/port already specified")
|
||||
conn = Connection(host, port)
|
||||
self.inactive_connections.append(conn)
|
||||
self.connections_condition.notifyAll()
|
||||
finally:
|
||||
self.connections_condition.release()
|
||||
|
||||
def waitForServer(self):
|
||||
"""Wait for at least one server to be connected.
|
||||
|
||||
Block until at least one gearman server is connected.
|
||||
"""
|
||||
connected = False
|
||||
while True:
|
||||
self.connections_condition.acquire()
|
||||
while not self.active_connections:
|
||||
self.log.debug("Waiting for at least one active connection")
|
||||
self.connections_condition.wait()
|
||||
if self.active_connections:
|
||||
self.log.debug("Active connection found")
|
||||
connected = True
|
||||
self.connections_condition.release()
|
||||
if connected:
|
||||
return
|
||||
|
||||
def _doConnectLoop(self):
|
||||
# Outer run method of the reconnection thread
|
||||
while True:
|
||||
self.connections_condition.acquire()
|
||||
while not self.inactive_connections:
|
||||
self.log.debug("Waiting for change in available servers "
|
||||
"to reconnect")
|
||||
self.connections_condition.wait()
|
||||
self.connections_condition.release()
|
||||
self.log.debug("Checking if servers need to be reconnected")
|
||||
try:
|
||||
if not self._connectLoop():
|
||||
# Nothing happened
|
||||
time.sleep(2)
|
||||
except:
|
||||
self.log.exception("Exception in connect loop:")
|
||||
|
||||
def _connectLoop(self):
|
||||
# Inner method of the reconnection loop, triggered by
|
||||
# a connection change
|
||||
success = False
|
||||
for conn in self.inactive_connections[:]:
|
||||
self.log.debug("Trying to reconnect %s" % conn)
|
||||
try:
|
||||
conn.reconnect()
|
||||
except ConnectionError:
|
||||
self.log.debug("Unable to connect to %s" % conn)
|
||||
continue
|
||||
except:
|
||||
self.log.error("Exception while connecting to %s" % conn)
|
||||
continue
|
||||
self.connections_condition.acquire()
|
||||
self.inactive_connections.remove(conn)
|
||||
self.active_connections.append(conn)
|
||||
self.connections_condition.notifyAll()
|
||||
os.write(self.wake_write, '1\n')
|
||||
self.connections_condition.release()
|
||||
success = True
|
||||
return success
|
||||
|
||||
def _lostConnection(self, conn):
|
||||
# Called as soon as a connection is detected as faulty. Remove
|
||||
# it and return ASAP and let the connection thread deal with it.
|
||||
self.log.debug("Marking %s as disconnected" % conn)
|
||||
self.connections_condition.acquire()
|
||||
self.active_connections.remove(conn)
|
||||
self.inactive_connections.append(conn)
|
||||
self.connections_condition.notifyAll()
|
||||
self.connections_condition.release()
|
||||
|
||||
def getConnection(self):
|
||||
"""Return a connected server.
|
||||
|
||||
Finds the next scheduled connected server in the round-robin
|
||||
rotation and returns it. It is not usually necessary to use
|
||||
this method external to the library, as more consumer-oriented
|
||||
methods such as submitJob already use it internally, but is
|
||||
available nonetheless if necessary.
|
||||
"""
|
||||
|
||||
conn = None
|
||||
try:
|
||||
self.connections_condition.acquire()
|
||||
if not self.active_connections:
|
||||
raise NoConnectedServersError("No connected Gearman servers")
|
||||
|
||||
self.connection_index += 1
|
||||
if self.connection_index >= len(self.active_connections):
|
||||
self.connection_index = 0
|
||||
conn = self.active_connections[self.connection_index]
|
||||
finally:
|
||||
self.connections_condition.release()
|
||||
return conn
|
||||
|
||||
def _doPollLoop(self):
|
||||
# Outer run method of poll thread.
|
||||
while True:
|
||||
self.connections_condition.acquire()
|
||||
while not self.active_connections:
|
||||
self.log.debug("Waiting for change in available servers "
|
||||
"to poll")
|
||||
self.connections_condition.wait()
|
||||
self.connections_condition.release()
|
||||
try:
|
||||
self._pollLoop()
|
||||
except:
|
||||
self.log.exception("Exception in poll loop:")
|
||||
|
||||
def _pollLoop(self):
|
||||
# Inner method of poll loop
|
||||
self.log.debug("Preparing to poll")
|
||||
poll = select.poll()
|
||||
bitmask = (select.POLLIN | select.POLLERR |
|
||||
select.POLLHUP | select.POLLNVAL)
|
||||
# Reverse mapping of fd -> connection
|
||||
conn_dict = {}
|
||||
for conn in self.active_connections:
|
||||
poll.register(conn.conn.fileno(), bitmask)
|
||||
conn_dict[conn.conn.fileno()] = conn
|
||||
# Register the wake pipe so that we can break if we need to
|
||||
# reconfigure connections
|
||||
poll.register(self.wake_read, bitmask)
|
||||
while True:
|
||||
self.log.debug("Polling %s connections" %
|
||||
len(self.active_connections))
|
||||
ret = poll.poll()
|
||||
for fd, event in ret:
|
||||
if fd == self.wake_read:
|
||||
self.log.debug("Woken by pipe")
|
||||
while True:
|
||||
if os.read(self.wake_read, 1) == '\n':
|
||||
break
|
||||
return
|
||||
if event & select.POLLIN:
|
||||
self.log.debug("Processing input on %s" % conn)
|
||||
p = conn_dict[fd].readPacket()
|
||||
if p:
|
||||
self.handlePacket(p)
|
||||
else:
|
||||
self.log.debug("Received no data on %s" % conn)
|
||||
self._lostConnection(conn_dict[fd])
|
||||
return
|
||||
else:
|
||||
self.log.debug("Received error event on %s" % conn)
|
||||
self._lostConnection(conn_dict[fd])
|
||||
return
|
||||
|
||||
def submitJob(self, job, background=False, precedence=PRECEDENCE_NORMAL):
|
||||
"""Submit a job to a Gearman server.
|
||||
|
||||
Submits the provided job to the next server in this client's
|
||||
round-robin connection pool.
|
||||
|
||||
If the job is a foreground job, updates will be made to the
|
||||
supplied :py:class:`Job` object as they are received.
|
||||
|
||||
:arg Job job: The :py:class:`Job` to submit.
|
||||
:arg bool background: Whether the job should be backgrounded.
|
||||
:arg int precedence: Whether the job should have normal, low, or
|
||||
high precedence. One of gear.PRECEDENCE_NORMAL,
|
||||
gear.PRECEDENCE_LOW, gear.PRECEDENCE_HIGH
|
||||
"""
|
||||
data = '%s\x00%s\x00%s' % (job.name, job.unique, job.arguments)
|
||||
if background:
|
||||
if precedence == PRECEDENCE_NORMAL:
|
||||
cmd = constants.SUBMIT_JOB_BG
|
||||
elif precedence == PRECEDENCE_LOW:
|
||||
cmd = constants.SUBMIT_JOB_LOW_BG
|
||||
elif precedence == PRECEDENCE_HIGH:
|
||||
cmd = constants.SUBMIT_JOB_HIGH_BG
|
||||
else:
|
||||
raise ConfigurationError("Invalid precedence value")
|
||||
else:
|
||||
if precedence == PRECEDENCE_NORMAL:
|
||||
cmd = constants.SUBMIT_JOB
|
||||
elif precedence == PRECEDENCE_LOW:
|
||||
cmd = constants.SUBMIT_JOB_LOW
|
||||
elif precedence == PRECEDENCE_HIGH:
|
||||
cmd = constants.SUBMIT_JOB_HIGH
|
||||
else:
|
||||
raise ConfigurationError("Invalid precedence value")
|
||||
p = Packet(constants.REQ, cmd, data)
|
||||
while True:
|
||||
conn = self.getConnection()
|
||||
conn.pending_jobs.append(job)
|
||||
try:
|
||||
conn.sendPacket(p)
|
||||
return
|
||||
except:
|
||||
self.log.exception("Exception while submitting job %s to %s" %
|
||||
(job, conn))
|
||||
conn.pending_jobs.remove(job)
|
||||
# If we can't send the packet, discard the connection and
|
||||
# try again
|
||||
self._lostConnection(conn_dict[fd])
|
||||
|
||||
def handlePacket(self, packet):
|
||||
"""Handle a packet received from a Gearman server.
|
||||
|
||||
This method is called whenever a packet is received from any
|
||||
of this client's connections. It normally calls the handle
|
||||
method appropriate for the specific packet.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
self.log.debug("Received packet %s" % packet)
|
||||
if packet.ptype == constants.JOB_CREATED:
|
||||
self.handleJobCreated(packet)
|
||||
elif packet.ptype == constants.WORK_COMPLETE:
|
||||
self.handleWorkComplete(packet)
|
||||
|
||||
def handleJobCreated(self, packet):
|
||||
"""Handle a JOB_CREATED packet.
|
||||
|
||||
Updates the appropriate :py:class:`Job` with the newly
|
||||
returned job handle.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.connection.pending_jobs.pop(0)
|
||||
job.handle = packet.data
|
||||
packet.connection.related_jobs[job.handle] = job
|
||||
|
||||
def handleWorkComplete(self, packet):
|
||||
"""Handle a WORK_COMPLETE packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data
|
||||
and removes it from the list of jobs associated with the
|
||||
connection.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.data += packet.getArgument(1)
|
||||
job.complete = True
|
||||
job.failure = False
|
||||
del packet.connection.related_jobs[job.handle]
|
||||
|
||||
def handleWorkFail(self, packet):
|
||||
"""Handle a WORK_FAIL packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data
|
||||
and removes it from the list of jobs associated with the
|
||||
connection.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.complete = True
|
||||
job.failure = True
|
||||
del packet.connection.related_jobs[job.handle]
|
||||
|
||||
def handleWorkException(self, packet):
|
||||
"""Handle a WORK_Exception packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data
|
||||
and removes it from the list of jobs associated with the
|
||||
connection.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.exception = packet.getArgument(1)
|
||||
job.complete = True
|
||||
job.failure = True
|
||||
del packet.connection.related_jobs[job.handle]
|
||||
|
||||
def handleWorkData(self, packet):
|
||||
"""Handle a WORK_DATA packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.data += packet.getArgument(1)
|
||||
|
||||
def handleWorkWarning(self, packet):
|
||||
"""Handle a WORK_WARNING packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.data += packet.getArgument(1)
|
||||
job.warning = True
|
||||
|
||||
def handleWorkStatus(self, packet):
|
||||
"""Handle a WORK_STATUS packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.numerator = packet.getArgument(1)
|
||||
job.denominator = packet.getArgument(1)
|
||||
try:
|
||||
job.percent_complete = float(job.numerator)/float(job.denominator)
|
||||
except:
|
||||
job.percent_complete = None
|
||||
|
||||
def handleStatusRes(self, packet):
|
||||
"""Handle a STATUS_RES packet.
|
||||
|
||||
Updates the referenced :py:class:`Job` with the returned data.
|
||||
|
||||
:arg Packet packet: The :py:class:`Packet` that was received.
|
||||
"""
|
||||
|
||||
job = packet.getJob()
|
||||
job.known = (packet.getArgument(1) == 1)
|
||||
job.running = (packet.getArgument(2) == 1)
|
||||
job.numerator = packet.getArgument(3)
|
||||
job.denominator = packet.getArgument(4)
|
||||
try:
|
||||
job.percent_complete = float(job.numerator)/float(job.denominator)
|
||||
except:
|
||||
job.percent_complete = None
|
||||
|
||||
class Job(object):
|
||||
log = logging.getLogger("gear.Job")
|
||||
|
||||
def __init__(self, name, arguments, unique):
|
||||
self.name = name
|
||||
self.arguments = arguments
|
||||
self.unique = unique
|
||||
self.handle = None
|
||||
self.data = b''
|
||||
self.exception = None
|
||||
self.warning = False
|
||||
self.complete = False
|
||||
self.failure = False
|
||||
self.numerator = None
|
||||
self.denominator = None
|
||||
self.percent_complete = None
|
||||
self.known = None
|
||||
self.running = None
|
||||
|
||||
def __repr__(self):
|
||||
return '<gear.Job 0x%x handle: %s name: %s unique: %s>' % (
|
||||
id(self), self.handle, self.name, self.unique)
|
58
gear/constants.py
Normal file
58
gear/constants.py
Normal file
@ -0,0 +1,58 @@
|
||||
# Copyright 2013 OpenStack Foundation
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
# not use this file except in compliance with the License. You may obtain
|
||||
# a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
types = {
|
||||
1: 'CAN_DO',
|
||||
2: 'CANT_DO',
|
||||
3: 'RESET_ABILITIES',
|
||||
4: 'PRE_SLEEP',
|
||||
#unused
|
||||
6: 'NOOP',
|
||||
7: 'SUBMIT_JOB',
|
||||
8: 'JOB_CREATED',
|
||||
9: 'GRAB_JOB',
|
||||
10: 'NO_JOB',
|
||||
11: 'JOB_ASSIGN',
|
||||
12: 'WORK_STATUS',
|
||||
13: 'WORK_COMPLETE',
|
||||
14: 'WORK_FAIL',
|
||||
15: 'GET_STATUS',
|
||||
16: 'ECHO_REQ',
|
||||
17: 'ECHO_RES',
|
||||
18: 'SUBMIT_JOB_BG',
|
||||
19: 'ERROR',
|
||||
20: 'STATUS_RES',
|
||||
21: 'SUBMIT_JOB_HIGH',
|
||||
22: 'SET_CLIENT_ID',
|
||||
23: 'CAN_DO_TIMEOUT',
|
||||
24: 'ALL_YOURS',
|
||||
25: 'WORK_EXCEPTION',
|
||||
26: 'OPTION_REQ',
|
||||
27: 'OPTION_RES',
|
||||
28: 'WORK_DATA',
|
||||
29: 'WORK_WARNING',
|
||||
30: 'GRAB_JOB_UNIQ',
|
||||
31: 'JOB_ASSIGN_UNIQ',
|
||||
32: 'SUBMIT_JOB_HIGH_BG',
|
||||
33: 'SUBMIT_JOB_LOW',
|
||||
34: 'SUBMIT_JOB_LOW_BG',
|
||||
35: 'SUBMIT_JOB_SCHED',
|
||||
36: 'SUBMIT_JOB_EPOCH',
|
||||
}
|
||||
|
||||
for i, name in types.items():
|
||||
globals()[name]=i
|
||||
|
||||
REQ = '\x00REQ'
|
||||
RES = '\x00RES'
|
Loading…
Reference in New Issue
Block a user