class SingleUserChunker:
"""
A user chunk waiter, which yields after the first received chunk. Used at ``Client.request_members``.
Attributes
----------
timer : `Handle`, `None`
The time-outer of the chunker, what will cancel if the timeout occurs.
waiter : ``Future``
The waiter future what will yield, when we receive the response, or when the timeout occurs.
"""
__slots__ = ('timer', 'waiter',)
def __init__(self, ):
self.waiter = Future(KOKORO)
self.timer = KOKORO.call_at(LOOP_TIME() + USER_CHUNK_TIMEOUT, type(self)._cancel, self)
def __call__(self, event):
"""
Called when a chunk is received with it's respective nonce.
Parameters
----------
event : ``GuildUserChunkEvent``
The received guild user chunk's event.
Returns
-------
is_last : `bool`
``SingleUserChunker`` returns always `True`, because it waits only for one event.
"""
self.waiter.set_result_if_pending(event.users)
timer = self.timer
if (timer is not None):
self.timer = None
timer.cancel()
return True
def _cancel(self):
"""
The chunker's timer calls this method.
Cancels ``.waiter`` and ``.timer``. After this method was called, the waiting coroutine will remove it's
reference from the event handler.
"""
self.waiter.cancel()
timer = self.timer
if (timer is not None):
self.timer = None
timer.cancel()
def cancel(self):
"""
Cancels the chunker.
This method should be called when when the chunker is canceller from outside. Before this method is called,
it's references should be removed as well from the event handler.
"""
self.waiter.set_result_if_pending([])
timer = self.timer
if (timer is not None):
self.timer = None
timer.cancel()
def __await__(self):
"""
Awaits the chunker's waiter and returns that's result.
Returns
-------
users : `list` of ``ClientUserBase`` objects
The received users. Can be an empty list.
Raises
------
CancelledError
If timeout occurred.
"""
return self.waiter.__await__()
class MassUserChunker:
"""
A user chunk waiter, which yields after the chunks of certain amount of guilds are received. Used at
``Client._request_members`` and at ``Client._request_members``.
Attributes
----------
last : `float`
The timestamp of the last received chunk.
timer : `Handle`, `None`
The time-outer of the chunker, what will cancel if the timeout occurs.
waiter : ``Future``
The waiter future what will yield, when we receive the response, or when the timeout occurs.
"""
__slots__ = ('last', 'timer', 'waiter',)
def __init__(self):
"""
Creates a new mass user chunker.
"""
self.waiter = Future(KOKORO)
self.last = now = LOOP_TIME()
self.timer = KOKORO.call_at(now + USER_CHUNK_TIMEOUT, type(self)._cancel, self)
def __call__(self, event):
"""
Called when a chunk is received with it's respective nonce.
Updates the chunker's last received chunk's time to push out the current timeout.
Parameters
----------
event : ``GuildUserChunkEvent``
The received guild user chunk's event.
Returns
-------
is_last : `bool`
Whether the last chunk was received.
"""
self.last = LOOP_TIME()
if event.index + 1 != event.count:
return False
self.waiter.set_result_if_pending(None)
timer = self.timer
if (timer is not None):
self.timer = None
timer.cancel()
return True
def _cancel(self):
"""
The chunker's timer calls this method. If the chunker received any chunks since it's ``.timer`` was started,
pushes out the timeout.
Cancels ``.waiter`` and ``.timer``. After this method was called, the waiting coroutine will remove it's
reference from the event handler.
"""
now = LOOP_TIME()
next_ = self.last + USER_CHUNK_TIMEOUT
if next_ > now:
self.timer = KOKORO.call_at(next_, type(self)._cancel, self)
else:
self.timer = None
self.waiter.cancel()
def cancel(self):
"""
Cancels the chunker.
This method should be called when when the chunker is canceller from outside. Before this method is called,
it's references should be removed as well from the event handler.
"""
self.waiter.set_result_if_pending(None)
timer = self.timer
if (timer is not None):
self.timer = None
timer.cancel()
def __await__(self):
"""
Awaits the chunker's waiter.
Raises
------
CancelledError
If timeout occurred.
"""
return self.waiter.__await__()