Instruções passo a passo: criando um agente de fluxo de dados
Este documento demonstra como criar aplicativos baseados em agente baseados em fluxo de dados, em vez de fluxo de controle.
Fluxo de controle se refere à ordem de execução das operações em um programa. O fluxo de controle é regulado usando estruturas de controle, como instruções condicionais, loops etc. Como alternativa, fluxo de dados se refere a um modelo de programação no qual os cálculos são feitos somente quando todos os dados necessários estão disponíveis. O modelo de programação de fluxo de dados está relacionado ao conceito de transmissão de mensagens, em que componentes independentes de um programa se comunicam uns com os outros pelo envio de mensagens.
Agentes assíncronos dão suporte aos modelos de programação de fluxo de controle e fluxo de dados. Embora o modelo de fluxo de controle seja apropriado em muitos casos, o modelo de fluxo de dados é apropriado em outros, por exemplo, quando um agente recebe dados e executa uma ação baseada no conteúdo desses dados.
Pré-requisitos
Leia os seguintes documentos antes de iniciar este passo a passo:
Seções
Este passo a passo contém as seguintes seções:
Criando um agente de fluxo de controle básico
Considere o exemplo a seguir que define a classe control_flow_agent. A classe control_flow_agent atua em três buffers de mensagem: um buffer de entrada e dois buffers de saída. O método run lê do buffer de mensagem de origem em um loop e usa uma instrução condicional para direcionar o fluxo de execução do programa. O agente incrementa um contador para valores não zero e negativos e incrementa outro contador para valores positivos não zero. Depois que o agente recebe o valor Sentinel de zero, ele envia os valores dos contadores para os buffers de mensagem de saída. Os métodos negatives e positives permitem que o aplicativo leia as contagens de valores negativos e positivos do agente.
// A basic agent that uses control-flow to regulate the order of program
// execution. This agent reads numbers from a message buffer and counts the
// number of positive and negative values.
class control_flow_agent : public agent
{
public:
explicit control_flow_agent(ISource<int>& source)
: _source(source)
{
}
// Retrieves the count of negative numbers that the agent received.
size_t negatives()
{
return receive(_negatives);
}
// Retrieves the count of positive numbers that the agent received.
size_t positives()
{
return receive(_positives);
}
protected:
void run()
{
// Counts the number of negative and positive values that
// the agent receives.
size_t negative_count = 0;
size_t positive_count = 0;
// Read from the source buffer until we receive
// the sentinel value of 0.
int value = 0;
while ((value = receive(_source)) != 0)
{
// Send negative values to the first target and
// non-negative values to the second target.
if (value < 0)
++negative_count;
else
++positive_count;
}
// Write the counts to the message buffers.
send(_negatives, negative_count);
send(_positives, positive_count);
// Set the agent to the completed state.
done();
}
private:
// Source message buffer to read from.
ISource<int>& _source;
// Holds the number of negative and positive numbers that the agent receives.
single_assignment<size_t> _negatives;
single_assignment<size_t> _positives;
};
Embora este exemplo faça uso básico do fluxo de controle em um agente, ele demonstra a natureza serial da programação baseada em fluxo de controle. Cada mensagem deve ser processada sequencialmente, embora várias mensagens possam estar disponíveis no buffer de mensagem de entrada. O modelo de fluxo de dados permite que ambas as ramificações da instrução condicional sejam avaliadas simultaneamente. O modelo de fluxo de dados também permite que você crie redes de mensagens mais complexas que atuam em dados à medida que eles ficam disponíveis.
Como criar um agente de fluxo de dados básico
Esta seção mostra como converter a classe control_flow_agent para usar o modelo de fluxo de dados para executar a mesma tarefa.
O agente de fluxo de dados funciona criando uma rede de buffers de mensagens, sendo que cada um deles atende a uma finalidade específica. Determinados blocos de mensagem usam uma função de filtro para aceitar ou rejeitar uma mensagem com base em seu conteúdo. Uma função de filtro garante que um bloco de mensagem receba apenas determinados valores.
Para converter o agente do fluxo de controle em um agente do fluxo de dados
Copie o corpo da classe
control_flow_agentpara outra classe, por exemplo,dataflow_agent. Como alternativa, você pode renomear a classecontrol_flow_agent.Remova o corpo do loop que chama
receivedo métodorun.
void run()
{
// Counts the number of negative and positive values that
// the agent receives.
size_t negative_count = 0;
size_t positive_count = 0;
// Write the counts to the message buffers.
send(_negatives, negative_count);
send(_positives, positive_count);
// Set the agent to the completed state.
done();
}
- No método
run, após a inicialização das variáveisnegative_countepositive_count, adicione um objetocountdown_eventque acompanha a contagem de operações ativas.
// Tracks the count of active operations.
countdown_event active;
// An event that is set by the sentinel.
event received_sentinel;
A classe countdown_event é exibida posteriormente neste tópico.
- Crie os objetos de buffer de mensagem que participarão da rede de fluxo de dados.
//
// Create the members of the dataflow network.
//
// Increments the active counter.
transformer<int, int> increment_active(
[&active](int value) -> int {
active.add_count();
return value;
});
// Increments the count of negative values.
call<int> negatives(
[&](int value) {
++negative_count;
// Decrement the active counter.
active.signal();
},
[](int value) -> bool {
return value < 0;
});
// Increments the count of positive values.
call<int> positives(
[&](int value) {
++positive_count;
// Decrement the active counter.
active.signal();
},
[](int value) -> bool {
return value > 0;
});
// Receives only the sentinel value of 0.
call<int> sentinel(
[&](int value) {
// Decrement the active counter.
active.signal();
// Set the sentinel event.
received_sentinel.set();
},
[](int value) -> bool {
return value == 0;
});
// Connects the _source message buffer to the rest of the network.
unbounded_buffer<int> connector;
- Conecte os buffers de mensagem para formar uma rede.
//
// Connect the network.
//
// Connect the internal nodes of the network.
connector.link_target(&negatives);
connector.link_target(&positives);
connector.link_target(&sentinel);
increment_active.link_target(&connector);
// Connect the _source buffer to the internal network to
// begin data flow.
_source.link_target(&increment_active);
- Aguarde até que os objetos
eventecountdown eventsejam definidos. Esses eventos sinalizam que o agente recebeu o valor Sentinel e que todas as operações foram concluídas.
// Wait for the sentinel event and for all operations to finish.
received_sentinel.wait();
active.wait();
O seguinte diagrama mostra a rede de fluxo de dados completa para a classe dataflow_agent:
A tabela a seguir descreve os membros da rede.
| Membro | Descrição |
|---|---|
increment_active |
Um objeto concurrency::transformer que incrementa o contador de eventos ativos e passa o valor de entrada para o restante da rede. |
negatives, positives |
Objetos concurrency::call que incrementam a contagem de números e reduzem o contador de eventos ativos. Cada um dos objetos usa um filtro para aceitar números negativos ou números positivos. |
sentinel |
Um objeto concurrency::call que aceita apenas o valor Sentinel de zero e diminui o contador de eventos ativo. |
connector |
Um objeto concurrency::unbounded_buffer que conecta o buffer de mensagem de origem à rede interna. |
Como o método run é chamado em um thread separado, outros threads podem enviar mensagens para a rede antes que a rede esteja totalmente conectada. O membro de dados _source é um objeto unbounded_buffer que armazena em buffer todas as entradas enviadas do aplicativo para o agente. Para garantir que a rede processe todas as mensagens de entrada, o agente primeiro vincula os nós internos da rede e, em seguida, vincula o início dessa rede, connector, ao membro de dados _source. Isso garante que as mensagens não sejam processadas, pois a rede está sendo formada.
Como a rede neste exemplo é baseada no fluxo de dados, em vez de no fluxo de controle, a rede deve comunicar ao agente que concluiu o processamento de cada valor de entrada e que o nó Sentinel recebeu seu valor. Este exemplo usa um objeto countdown_event para sinalizar que todos os valores de entrada foram processados e um objeto concurrency::event para indicar que o nó Sentinel recebeu seu valor. A classe countdown_event usa um objeto event para sinalizar quando um valor de contador atinge zero. O chefe da rede de fluxo de dados incrementa o contador sempre que recebe um valor. Cada nó de terminal da rede diminui o contador depois que ele processa o valor de entrada. Depois que o agente forma a rede de fluxo de dados, ele aguarda o nó Sentinel definir o objeto event e para que o objeto countdown_event sinalize que seu contador atingiu zero.
O exemplo a seguir mostra as classes control_flow_agent, dataflow_agent e countdown_event. A função wmain cria objetos control_flow_agent e dataflow_agent e usa a função send_values para enviar uma série de valores aleatórios aos agentes.
// dataflow-agent.cpp
// compile with: /EHsc
#include <windows.h>
#include <agents.h>
#include <iostream>
#include <random>
using namespace concurrency;
using namespace std;
// A basic agent that uses control-flow to regulate the order of program
// execution. This agent reads numbers from a message buffer and counts the
// number of positive and negative values.
class control_flow_agent : public agent
{
public:
explicit control_flow_agent(ISource<int>& source)
: _source(source)
{
}
// Retrieves the count of negative numbers that the agent received.
size_t negatives()
{
return receive(_negatives);
}
// Retrieves the count of positive numbers that the agent received.
size_t positives()
{
return receive(_positives);
}
protected:
void run()
{
// Counts the number of negative and positive values that
// the agent receives.
size_t negative_count = 0;
size_t positive_count = 0;
// Read from the source buffer until we receive
// the sentinel value of 0.
int value = 0;
while ((value = receive(_source)) != 0)
{
// Send negative values to the first target and
// non-negative values to the second target.
if (value < 0)
++negative_count;
else
++positive_count;
}
// Write the counts to the message buffers.
send(_negatives, negative_count);
send(_positives, positive_count);
// Set the agent to the completed state.
done();
}
private:
// Source message buffer to read from.
ISource<int>& _source;
// Holds the number of negative and positive numbers that the agent receives.
single_assignment<size_t> _negatives;
single_assignment<size_t> _positives;
};
// A synchronization primitive that is signaled when its
// count reaches zero.
class countdown_event
{
public:
countdown_event(unsigned int count = 0L)
: _current(static_cast<long>(count))
{
// Set the event if the initial count is zero.
if (_current == 0L)
_event.set();
}
// Decrements the event counter.
void signal() {
if(InterlockedDecrement(&_current) == 0L) {
_event.set();
}
}
// Increments the event counter.
void add_count() {
if(InterlockedIncrement(&_current) == 1L) {
_event.reset();
}
}
// Blocks the current context until the event is set.
void wait() {
_event.wait();
}
private:
// The current count.
volatile long _current;
// The event that is set when the counter reaches zero.
event _event;
// Disable copy constructor.
countdown_event(const countdown_event&);
// Disable assignment.
countdown_event const & operator=(countdown_event const&);
};
// A basic agent that resembles control_flow_agent, but uses uses dataflow to
// perform computations when data becomes available.
class dataflow_agent : public agent
{
public:
dataflow_agent(ISource<int>& source)
: _source(source)
{
}
// Retrieves the count of negative numbers that the agent received.
size_t negatives()
{
return receive(_negatives);
}
// Retrieves the count of positive numbers that the agent received.
size_t positives()
{
return receive(_positives);
}
protected:
void run()
{
// Counts the number of negative and positive values that
// the agent receives.
size_t negative_count = 0;
size_t positive_count = 0;
// Tracks the count of active operations.
countdown_event active;
// An event that is set by the sentinel.
event received_sentinel;
//
// Create the members of the dataflow network.
//
// Increments the active counter.
transformer<int, int> increment_active(
[&active](int value) -> int {
active.add_count();
return value;
});
// Increments the count of negative values.
call<int> negatives(
[&](int value) {
++negative_count;
// Decrement the active counter.
active.signal();
},
[](int value) -> bool {
return value < 0;
});
// Increments the count of positive values.
call<int> positives(
[&](int value) {
++positive_count;
// Decrement the active counter.
active.signal();
},
[](int value) -> bool {
return value > 0;
});
// Receives only the sentinel value of 0.
call<int> sentinel(
[&](int value) {
// Decrement the active counter.
active.signal();
// Set the sentinel event.
received_sentinel.set();
},
[](int value) -> bool {
return value == 0;
});
// Connects the _source message buffer to the rest of the network.
unbounded_buffer<int> connector;
//
// Connect the network.
//
// Connect the internal nodes of the network.
connector.link_target(&negatives);
connector.link_target(&positives);
connector.link_target(&sentinel);
increment_active.link_target(&connector);
// Connect the _source buffer to the internal network to
// begin data flow.
_source.link_target(&increment_active);
// Wait for the sentinel event and for all operations to finish.
received_sentinel.wait();
active.wait();
// Write the counts to the message buffers.
send(_negatives, negative_count);
send(_positives, positive_count);
// Set the agent to the completed state.
done();
}
private:
// Source message buffer to read from.
ISource<int>& _source;
// Holds the number of negative and positive numbers that the agent receives.
single_assignment<size_t> _negatives;
single_assignment<size_t> _positives;
};
// Sends a number of random values to the provided message buffer.
void send_values(ITarget<int>& source, int sentinel, size_t count)
{
// Send a series of random numbers to the source buffer.
mt19937 rnd(42);
for (size_t i = 0; i < count; ++i)
{
// Generate a random number that is not equal to the sentinel value.
int n;
while ((n = rnd()) == sentinel);
send(source, n);
}
// Send the sentinel value.
send(source, sentinel);
}
int wmain()
{
// Signals to the agent that there are no more values to process.
const int sentinel = 0;
// The number of samples to send to each agent.
const size_t count = 1000000;
// The source buffer that the application writes numbers to and
// the agents read numbers from.
unbounded_buffer<int> source;
//
// Use a control-flow agent to process a series of random numbers.
//
wcout << L"Control-flow agent:" << endl;
// Create and start the agent.
control_flow_agent cf_agent(source);
cf_agent.start();
// Send values to the agent.
send_values(source, sentinel, count);
// Wait for the agent to finish.
agent::wait(&cf_agent);
// Print the count of negative and positive numbers.
wcout << L"There are " << cf_agent.negatives()
<< L" negative numbers."<< endl;
wcout << L"There are " << cf_agent.positives()
<< L" positive numbers."<< endl;
//
// Perform the same task, but this time with a dataflow agent.
//
wcout << L"Dataflow agent:" << endl;
// Create and start the agent.
dataflow_agent df_agent(source);
df_agent.start();
// Send values to the agent.
send_values(source, sentinel, count);
// Wait for the agent to finish.
agent::wait(&df_agent);
// Print the count of negative and positive numbers.
wcout << L"There are " << df_agent.negatives()
<< L" negative numbers."<< endl;
wcout << L"There are " << df_agent.positives()
<< L" positive numbers."<< endl;
}
Este exemplo gera a seguinte saída de amostra:
Control-flow agent:
There are 500523 negative numbers.
There are 499477 positive numbers.
Dataflow agent:
There are 500523 negative numbers.
There are 499477 positive numbers.
Compilando o código
Copie o código de exemplo e cole-o em um projeto do Visual Studio, ou cole-o em um arquivo chamado dataflow-agent.cpp e execute o comando a seguir em uma janela do Prompt de comando do Visual Studio.
cl.exe /EHsc dataflow-agent.cpp
Criando um agente de log de mensagens
O exemplo a seguir mostra a classe log_agent, que se assemelha à classe dataflow_agent. A classe log_agent implementa um agente de registro em log assíncrono que grava mensagens de log em um arquivo e no console. A classe log_agent permite que o aplicativo categorize mensagens como informativas, avisos ou erros. Ela também permite que o aplicativo especifique se cada categoria de log é gravada em um arquivo, no console ou em ambos. Este exemplo grava todas as mensagens de log em um arquivo e apenas mensagens de erro no console.
// log-filter.cpp
// compile with: /EHsc
#include <windows.h>
#include <agents.h>
#include <sstream>
#include <fstream>
#include <iostream>
using namespace concurrency;
using namespace std;
// A synchronization primitive that is signaled when its
// count reaches zero.
class countdown_event
{
public:
countdown_event(unsigned int count = 0L)
: _current(static_cast<long>(count))
{
// Set the event if the initial count is zero.
if (_current == 0L)
{
_event.set();
}
}
// Decrements the event counter.
void signal()
{
if(InterlockedDecrement(&_current) == 0L)
{
_event.set();
}
}
// Increments the event counter.
void add_count()
{
if(InterlockedIncrement(&_current) == 1L)
{
_event.reset();
}
}
// Blocks the current context until the event is set.
void wait()
{
_event.wait();
}
private:
// The current count.
volatile long _current;
// The event that is set when the counter reaches zero.
event _event;
// Disable copy constructor.
countdown_event(const countdown_event&);
// Disable assignment.
countdown_event const & operator=(countdown_event const&);
};
// Defines message types for the logger.
enum log_message_type
{
log_info = 0x1,
log_warning = 0x2,
log_error = 0x4,
};
// An asynchronous logging agent that writes log messages to
// file and to the console.
class log_agent : public agent
{
// Holds a message string and its logging type.
struct log_message
{
wstring message;
log_message_type type;
};
public:
log_agent(const wstring& file_path, log_message_type file_messages, log_message_type console_messages)
: _file(file_path)
, _file_messages(file_messages)
, _console_messages(console_messages)
, _active(0)
{
if (_file.bad())
{
throw invalid_argument("Unable to open log file.");
}
}
// Writes the provided message to the log.
void log(const wstring& message, log_message_type type)
{
// Increment the active message count.
_active.add_count();
// Send the message to the network.
log_message msg = { message, type };
send(_log_buffer, msg);
}
void close()
{
// Signal that the agent is now closed.
_closed.set();
}
protected:
void run()
{
//
// Create the dataflow network.
//
// Writes a log message to file.
call<log_message> writer([this](log_message msg)
{
if ((msg.type & _file_messages) != 0)
{
// Write the message to the file.
write_to_stream(msg, _file);
}
if ((msg.type & _console_messages) != 0)
{
// Write the message to the console.
write_to_stream(msg, wcout);
}
// Decrement the active counter.
_active.signal();
});
// Connect _log_buffer to the internal network to begin data flow.
_log_buffer.link_target(&writer);
// Wait for the closed event to be signaled.
_closed.wait();
// Wait for all messages to be processed.
_active.wait();
// Close the log file and flush the console.
_file.close();
wcout.flush();
// Set the agent to the completed state.
done();
}
private:
// Writes a logging message to the specified output stream.
void write_to_stream(const log_message& msg, wostream& stream)
{
// Write the message to the stream.
wstringstream ss;
switch (msg.type)
{
case log_info:
ss << L"info: ";
break;
case log_warning:
ss << L"warning: ";
break;
case log_error:
ss << L"error: ";
}
ss << msg.message << endl;
stream << ss.str();
}
private:
// The file stream to write messages to.
wofstream _file;
// The log message types that are written to file.
log_message_type _file_messages;
// The log message types that are written to the console.
log_message_type _console_messages;
// The head of the network. Propagates logging messages
// to the rest of the network.
unbounded_buffer<log_message> _log_buffer;
// Counts the number of active messages in the network.
countdown_event _active;
// Signals that the agent has been closed.
event _closed;
};
int wmain()
{
// Union of all log message types.
log_message_type log_all = log_message_type(log_info | log_warning | log_error);
// Create a logging agent that writes all log messages to file and error
// messages to the console.
log_agent logger(L"log.txt", log_all, log_error);
// Start the agent.
logger.start();
// Log a few messages.
logger.log(L"===Logging started.===", log_info);
logger.log(L"This is a sample warning message.", log_warning);
logger.log(L"This is a sample error message.", log_error);
logger.log(L"===Logging finished.===", log_info);
// Close the logger and wait for the agent to finish.
logger.close();
agent::wait(&logger);
}
Este exemplo grava a saída a seguir no console.
error: This is a sample error message.
Este exemplo também produz o arquivo log.txt, que contém o texto a seguir.
info: ===Logging started.===
warning: This is a sample warning message.
error: This is a sample error message.
info: ===Logging finished.===
Compilando o código
Copie o código de exemplo e cole-o em um projeto do Visual Studio, ou cole-o em um arquivo chamado log-filter.cpp e execute o comando a seguir em uma janela do Prompt de comando do Visual Studio.
cl.exe /EHsc log-filter.cpp