faust.types.channels

class faust.types.channels.AppT

class faust.types.channels.EventT

class faust.types.channels.ModelArg

class faust.types.channels.StreamT

class faust.types.channels.ConsumerT

class faust.types.channels.TPorTopicSet

class faust.types.channels.ChannelT(app: faust.types.channels.AppT, *, key_type: faust.types.channels.ModelArg = None, value_type: faust.types.channels.ModelArg = None, is_iterator: bool = False, queue: mode.utils.queues.ThrowableQueue = None, maxsize: int = None, root: Optional[faust.types.channels.ChannelT] = None, active_partitions: Set[faust.types.tuples.TP] = None, loop: asyncio.events.AbstractEventLoop = None) → None

clone(*, is_iterator: bool = None, **kwargs) → faust.types.channels.ChannelT

Return type:ChannelT[]

clone_using_queue(queue: asyncio.queues.Queue) → faust.types.channels.ChannelT

Return type:ChannelT[]

stream(**kwargs) → faust.types.channels.StreamT

Return type:StreamT

get_topic_name() → str

Return type:str

as_future_message(key: Union[bytes, faust.types.core.ModelT, Any, None] = None, value: Union[bytes, faust.types.core.ModelT, Any] = None, partition: int = None, key_serializer: Union[faust.types.codecs.CodecT, str, None] = None, value_serializer: Union[faust.types.codecs.CodecT, str, None] = None, callback: Callable[faust.types.tuples.FutureMessage, Union[None, Awaitable[None]]] = None) → faust.types.tuples.FutureMessage

Return type:FutureMessage[]

prepare_key(key: Union[bytes, faust.types.core.ModelT, Any, None], key_serializer: Union[faust.types.codecs.CodecT, str, None]) → Any

Return type:Any

prepare_value(value: Union[bytes, faust.types.core.ModelT, Any], value_serializer: Union[faust.types.codecs.CodecT, str, None]) → Any

Return type:Any

empty() → bool

Return type:bool

on_stop_iteration() → None

Return type:None

derive(**kwargs) → faust.types.channels.ChannelT

Return type:ChannelT[]

subscriber_count

Return type:int

queue

Return type:ThrowableQueue

coroutine declare(self) → None

Return type:None

coroutine decode(self, message: faust.types.tuples.Message, *, propagate: bool = False) → faust.types.channels.EventT

Return type:EventT

coroutine deliver(self, message: faust.types.tuples.Message) → None

Return type:None

coroutine get(self, *, timeout: Union[datetime.timedelta, float, str] = None) → Any

Return type:Any

maybe_declare

coroutine on_decode_error(self, exc: Exception, message: faust.types.tuples.Message) → None

Return type:None

coroutine on_key_decode_error(self, exc: Exception, message: faust.types.tuples.Message) → None

Return type:None

coroutine on_value_decode_error(self, exc: Exception, message: faust.types.tuples.Message) → None

Return type:None

coroutine publish_message(self, fut: faust.types.tuples.FutureMessage, wait: bool = True) → Awaitable[faust.types.tuples.RecordMetadata]

Return type:Awaitable[RecordMetadata]

coroutine put(self, value: Any) → None

Return type:None

coroutine send(self, *, key: Union[bytes, faust.types.core.ModelT, Any, None] = None, value: Union[bytes, faust.types.core.ModelT, Any] = None, partition: int = None, key_serializer: Union[faust.types.codecs.CodecT, str, None] = None, value_serializer: Union[faust.types.codecs.CodecT, str, None] = None, callback: Callable[faust.types.tuples.FutureMessage, Union[None, Awaitable[None]]] = None, force: bool = False) → Awaitable[faust.types.tuples.RecordMetadata]

Return type:Awaitable[RecordMetadata]

coroutine throw(self, exc: BaseException) → None

Return type:None