Classe single_assignment
Um bloco de mensagens single_assignment
é um propagator_block
de vários destinos, de várias origens e ordenado capaz de armazenar um message
único, de gravação única.
Sintaxe
template<class T>
class single_assignment : public propagator_block<multi_link_registry<ITarget<T>>, multi_link_registry<ISource<T>>>;
Parâmetros
T
O tipo de conteúdo das mensagens armazenadas e propagadas pelo buffer.
Membros
Construtores públicos
Nome | Descrição |
---|---|
single_assignment | Sobrecarregado. Constrói um bloco de mensagens single_assignment . |
Destruidor ~single_assignment | Destrói o bloco de mensagens single_assignment . |
Métodos públicos
Nome | Descrição |
---|---|
has_value | Verifica se esse bloco de mensagens single_assignment foi inicializado com um valor ainda. |
value | Obtém uma referência ao conteúdo atual da mensagem que está sendo armazenada no bloco de mensagens single_assignment . |
Métodos protegidos
Nome | Descrição |
---|---|
accept_message | Aceita uma mensagem oferecida por esse bloco de mensagens single_assignment , retornando uma cópia da mensagem para o chamador. |
consume_message | Consome uma mensagem oferecida anteriormente por single_assignment e reservada pelo destino, retornando uma cópia da mensagem ao chamador. |
link_target_notification | Um retorno de chamada que notifica que um novo destino foi vinculado a esse bloco de mensagens single_assignment . |
propagate_message | Passa uma mensagem de modo assíncrono de um bloco ISource para este bloco de mensagens single_assignment . Ele é invocado pelo método propagate , quando chamado por um bloco de origem. |
propagate_to_any_targets | Coloca o message _PMessage neste bloco de mensagens single_assignment e oferece-o a todos os destinos vinculados. |
release_message | Libera uma reserva de mensagem anterior. (Substitui source_block::release_message.) |
reserve_message | Reserva uma mensagem oferecida anteriormente por este bloco de mensagens single_assignment . (Substitui source_block::reserve_message.) |
resume_propagation | Retoma a propagação depois que uma reserva é liberada. (Substitui source_block::resume_propagation.) |
send_message | De maneira síncrona, passa uma mensagem de um bloco ISource para este bloco de mensagens single_assignment . Ele é invocado pelo método send , quando chamado por um bloco de origem. |
Comentários
Um bloco de mensagens single_assignment
propaga cópias de sua mensagem para cada destino.
Para mais informações, confira Blocos de mensagens assíncronas.
Hierarquia de herança
single_assignment
Requisitos
Cabeçalho: agents.h
Namespace: concurrency
accept_message
Aceita uma mensagem oferecida por esse bloco de mensagens single_assignment
, retornando uma cópia da mensagem para o chamador.
virtual message<T>* accept_message(runtime_object_identity _MsgId);
Parâmetros
_MsgId
O runtime_object_identity
do objeto message
oferecido.
Valor de retorno
Um ponteiro para o objeto message
do qual o chamador agora tem propriedade.
Comentários
O bloco de mensagens single_assignment
retorna cópias da mensagem para seus destinos, em vez de transferir a propriedade da mensagem atualmente mantida.
consume_message
Consome uma mensagem oferecida anteriormente por single_assignment
e reservada pelo destino, retornando uma cópia da mensagem ao chamador.
virtual message<T>* consume_message(runtime_object_identity _MsgId);
Parâmetros
_MsgId
O runtime_object_identity
do objeto message
que está sendo consumido.
Valor de retorno
Um ponteiro para o objeto message
do qual o chamador agora tem propriedade.
Comentários
Semelhante a accept
, mas é sempre precedido por uma chamada para reserve
.
has_value
Verifica se esse bloco de mensagens single_assignment
foi inicializado com um valor ainda.
bool has_value() const;
Valor de retorno
true
se o bloco tiver recebido um valor; caso contrário, false
.
link_target_notification
Um retorno de chamada que notifica que um novo destino foi vinculado a esse bloco de mensagens single_assignment
.
virtual void link_target_notification(_Inout_ ITarget<T>* _PTarget);
Parâmetros
_PTarget
Um ponteiro para o destino que acaba de ser vinculado.
propagate_message
Passa uma mensagem de modo assíncrono de um bloco ISource
para este bloco de mensagens single_assignment
. Ele é invocado pelo método propagate
, quando chamado por um bloco de origem.
virtual message_status propagate_message(
_Inout_ message<T>* _PMessage,
_Inout_ ISource<T>* _PSource);
Parâmetros
_PMessage
Um ponteiro para o message
objeto.
_PSource
Um ponteiro para o bloco de origem que oferece a mensagem.
Valor de retorno
Uma indicação de message_status do que o destino decidiu fazer com a mensagem.
propagate_to_any_targets
Coloca o message
_PMessage
single_assignment
neste bloco de mensagens e o oferece a todos os destinos vinculados.
virtual void propagate_to_any_targets(_Inout_opt_ message<T>* _PMessage);
Parâmetros
_PMessage
Um ponteiro para um message
do qual esse bloco de mensagens single_assignment
obteve a propriedade.
release_message
Libera uma reserva de mensagem anterior.
virtual void release_message(runtime_object_identity _MsgId);
Parâmetros
_MsgId
O runtime_object_identity
do objeto message
que está sendo liberado.
reserve_message
Reserva uma mensagem oferecida anteriormente por este bloco de mensagens single_assignment
.
virtual bool reserve_message(runtime_object_identity _MsgId);
Parâmetros
_MsgId
O runtime_object_identity
do objeto message
que está sendo reservado.
Valor de retorno
true
se a mensagem foi reservada com êxito; caso contrário, false
.
Comentários
Depois de reserve
ser chamado, se ele retornar true
, consume
ou release
deverá ser chamado para assumir ou liberar a propriedade da mensagem.
resume_propagation
Retoma a propagação depois que uma reserva é liberada.
virtual void resume_propagation();
send_message
De maneira síncrona, passa uma mensagem de um bloco ISource
para este bloco de mensagens single_assignment
. Ele é invocado pelo método send
, quando chamado por um bloco de origem.
virtual message_status send_message(
_Inout_ message<T>* _PMessage,
_Inout_ ISource<T>* _PSource);
Parâmetros
_PMessage
Um ponteiro para o message
objeto.
_PSource
Um ponteiro para o bloco de origem que oferece a mensagem.
Valor de retorno
Uma indicação de message_status do que o destino decidiu fazer com a mensagem.
single_assignment
Constrói um bloco de mensagens single_assignment
.
single_assignment();
single_assignment(
filter_method const& _Filter);
single_assignment(
Scheduler& _PScheduler);
single_assignment(
Scheduler& _PScheduler,
filter_method const& _Filter);
single_assignment(
ScheduleGroup& _PScheduleGroup);
single_assignment(
ScheduleGroup& _PScheduleGroup,
filter_method const& _Filter);
Parâmetros
_Filter
Uma função de filtro que determina se as mensagens oferecidas devem ser aceitas.
_PScheduler
O objeto Scheduler
no qual a tarefa de propagação do bloco de mensagens single_assignment
está agendada.
_PScheduleGroup
O objeto ScheduleGroup
no qual a tarefa de propagação do bloco de mensagens single_assignment
está agendada. O objeto Scheduler
usado é implícito pelo grupo agendado.
Comentários
O runtime usará o agendador padrão se você não especificar os parâmetros _PScheduler
ou _PScheduleGroup
.
O tipo filter_method
é um functor com assinatura bool (T const &)
invocado por esse bloco de mensagens single_assignment
para determinar se ele deve ou não aceitar uma mensagem oferecida.
~ single_assignment
Destrói o bloco de mensagens single_assignment
.
~single_assignment();
value
Obtém uma referência ao conteúdo atual da mensagem que está sendo armazenada no bloco de mensagens single_assignment
.
T const& value();
Valor de retorno
O conteúdo da mensagem armazenada.
Comentários
Esse método aguardará até que uma mensagem chegue se nenhuma mensagem estiver armazenada no bloco de mensagens single_assignment
no momento.
Confira também
Namespace de simultaneidade
Classe overwrite_buffer
Classe unbounded_buffer