summary refs log tree commit diff
path: root/synapse/util/async.py
blob: d4d1d4b4726b0a496a3296d457fcee366ab59a81 (plain) (blame)
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
# -*- coding: utf-8 -*-
# Copyright 2014, 2015 OpenMarket Ltd
#
# 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.


from twisted.internet import defer, reactor

from .logcontext import PreserveLoggingContext


@defer.inlineCallbacks
def sleep(seconds):
    d = defer.Deferred()
    reactor.callLater(seconds, d.callback, seconds)
    with PreserveLoggingContext():
        yield d


def run_on_reactor():
    """ This will cause the rest of the function to be invoked upon the next
    iteration of the main loop
    """
    return sleep(0)


def time_bound_deferred(given_deferred, clock, time_out):
    ret_deferred = defer.Deferred()

    def timed_out():
        if not given_deferred.called:
            given_deferred.cancel()
            ret_deferred.errback(RuntimeError("Timed out"))

    timer = clock.call_later(time_out, timed_out)

    def succeed(result):
        clock.cancel_call_later(timer)
        ret_deferred.callback(result)

    given_deferred.addCallback(succeed)
    given_deferred.addErrback(ret_deferred.errback)

    return ret_deferred