File: cls-workermanager.rst

package info (click to toggle)
buildbot 4.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 21,080 kB
  • sloc: python: 174,183; sh: 1,204; makefile: 332; javascript: 119; xml: 16
file content (43 lines) | stat: -rw-r--r-- 1,233 bytes parent folder | download | duplicates (3)
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
WorkerManager
=============

.. py:module:: buildbot.worker.manager

WorkerRegistration
------------------

.. py:class:: WorkerRegistration(master, worker)

    Represents single worker registration.

    .. py:method:: unregister()

        Remove registration for `worker`.

    .. py:method:: update(worker_config, global_config)

        :param worker_config: new Worker instance
        :type worker_config: :class:`~buildbot.worker.Worker`
        :param global_config: Buildbot config
        :type global_config: :class:`~buildbot.config.MasterConfig`

        Update the registration in case the port or password has changed.

        .. note:: You should invoke this method after calling `WorkerManager.register(worker)`.

WorkerManager
-------------

.. py:class:: WorkerManager(master)

    Handle worker registrations for multiple protocols.

    .. py:method:: register(worker)

        :param worker: new Worker instance
        :type worker: :class:`~buildbot.worker.Worker`
        :returns: :class:`~buildbot.worker.manager.WorkerRegistration`

        Creates :class:`~buildbot.worker.manager.WorkerRegistration` instance.

        .. note:: You should invoke `.update()` on returned WorkerRegistration instance.