United States (English)

Home Library Learn Samples Downloads Support Community Forums

MSDN Library

Development Tools and Languages

Visual Studio 2012

Visual C++

Parallel Programming

Concurrency Runtime

Reference

concurrency Namespace

affinity_partitioner Class

agent Class

agent_status Enumeration

AgentEventGuid Constant

Agents_EventType Enumeration

auto_partitioner Class

bad_target Class

call Class

cancel_current_task Function

cancellation_token Class

cancellation_token_registration Class

cancellation_token_source Class

choice Class

ChoreEventGuid Constant

combinable Class

ConcRT_EventType Enumeration

ConcRT_ProviderGuid Constant

CONCRT_RM_VERSION_1 Constant

Concrt_TraceFlags Enumeration

ConcRTEventGuid Constant

COOPERATIVE_TIMEOUT_INFINITE Constant

COOPERATIVE_WAIT_TIMEOUT Constant

concurrent_priority_queue Class

concurrent_queue Class

concurrent_unordered_map Class

concurrent_unordered_multimap Class

concurrent_unordered_multiset Class

concurrent_unordered_set Class

concurrent_vector Class

Context Class

ContextEventGuid Constant

context_self_unblock Class

context_unblock_unbalanced Class

create_async Function

CreateResourceManager Function

create_task Function

critical_section Class

CriticalRegionType Enumeration

CurrentScheduler Class

default_scheduler_exists Class

DisableTracing Function

DispatchState Structure

DynamicProgressFeedbackType Enumeration

EnableTracing Function

event Class (Concurrency Runtime)

Free Function

GetExecutionContextId Function

GetOSVersion Function

GetProcessorCount Function

GetProcessorNodeCount Function

GetSchedulerId Function

IExecutionContext Structure

IExecutionResource Structure

improper_lock Class

improper_scheduler_attach Class

improper_scheduler_detach Class

improper_scheduler_reference Class

INHERIT_THREAD_PRIORITY Constant

internal_assign_iterators Function

interruption_point Function

invalid_link_target Class

invalid_multiple_scheduling Class

invalid_operation Class

invalid_oversubscribe_operation Class

invalid_scheduler_policy_key Class

invalid_scheduler_policy_thread_specification Class

invalid_scheduler_policy_value Class

IResourceManager Structure

is_current_task_group_canceling Function

is_task_cancellation_requested Function

IScheduler Structure

ISchedulerProxy Structure

ISource Class

ITarget Class

IThreadProxy Structure

ITopologyExecutionResource Structure

ITopologyNode Structure

IUMSCompletionList Structure

IUMSScheduler Structure

IUMSThreadProxy Structure

IUMSUnblockNotification Structure

IVirtualProcessorRoot Structure

join Class

join_type Enumeration

LockEventGuid Constant

make_choice Function

make_greedy_join Function

make_join Function

make_task Function

MaxExecutionResources Constant

message Class

message_not_found Class

message_processor Class

message_status Enumeration

missing_wait Class

multi_link_registry Class

multitype_join Class

nested_scheduler_missing_detach Class

network_link_registry Class

operation_timed_out Class

operator|| Operator

operator&& Operator

operator== Operator

operator!= Operator

operator< Operator

operator<= Operator

operator> Operator

operator>= Operator

ordered_message_processor Class

overwrite_buffer Class

parallel_buffered_sort Function

parallel_for Function

parallel_for_each Function

parallel_invoke Function

parallel_radixsort Function

parallel_reduce Function

parallel_sort Function

parallel_transform Function

PolicyElementKey Enumeration

PPLParallelForEventGuid Constant

PPLParallelForeachEventGuid Constant

PPLParallelInvokeEventGuid Constant

progress_reporter Class

propagator_block Class

reader_writer_lock Class

receive Function

ResourceManagerEventGuid Constant

run_with_cancellation_token Function

ScheduleGroup Class

ScheduleGroupEventGuid Constant

Scheduler Class

SchedulerEventGuid Constant

scheduler_not_attached Class

scheduler_resource_allocation_error Class

scheduler_worker_creation_error Class

SchedulerPolicy Class

SchedulerType Enumeration

SchedulingProtocolType Enumeration

send Function

set_task_execution_resources Function

simple_partitioner Class

single_assignment Class

single_link_registry Class

source_block Class

source_link_manager Class

static_partitioner Class

structured_task_group Class

swap Function

SwitchingProxyState Enumeration

target_block Class

task Class (Concurrency Runtime)

task_canceled Class

task_completion_event Class

task_continuation_context Class

task_group Class

task_group_status Enumeration

task_handle Class

timer Class

Trace_agents_register_name Function

transformer Class

try_receive Function

unbounded_buffer Class

unsupported_os Class

VirtualProcessorEventGuid Constant

wait Function

when_all Function

when_any Function

WinRTInitializationType Enumeration

Minimize

This topic has not yet been rated - Rate this topic

receive Function

Visual Studio 2012

Visual Studio 2010

A general receive implementation, allowing a context to wait for data from exactly one source and filter the values that are accepted.

template <
   class _Type
>
_Type receive(
   _Inout_ ISource<_Type> * _Src,
   unsigned int _Timeout = COOPERATIVE_TIMEOUT_INFINITE
);

template <
   class _Type
>
_Type receive(
   _Inout_ ISource<_Type> * _Src,
   typename ITarget<_Type>::filter_method const& _Filter_proc,
   unsigned int _Timeout = COOPERATIVE_TIMEOUT_INFINITE
);

template <
   class _Type
>
_Type receive(
   ISource<_Type> &_Src,
   unsigned int _Timeout = COOPERATIVE_TIMEOUT_INFINITE
);

template <
   class _Type
>
_Type receive(
   ISource<_Type> &_Src,
   typename ITarget<_Type>::filter_method const& _Filter_proc,
   unsigned int _Timeout = COOPERATIVE_TIMEOUT_INFINITE
);

_Type: The payload type.
_Src: A pointer or reference to the source from which data is expected.
_Timeout: The maximum time for which the method should for the data, in milliseconds.
_Filter_proc: A filter function which determines whether messages should be accepted.

A value from the source, of the payload type.

If the parameter _Timeout has a value other than the constant COOPERATIVE_TIMEOUT_INFINITE, the exception operation_timed_out is thrown if the specified amount of time expires before a message is received. If you want a zero length timeout, you should use the try_receive function, as opposed to calling receive with a timeout of 0 (zero), as it is more efficient and does not throw exceptions on timeouts.

For more information, see Message Passing Functions.

Header: agents.h

Namespace: concurrency

Reference

concurrency Namespace

try_receive Function

send Function

asend Function

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

© 2013 Microsoft. All rights reserved.