pp::ext::ExtCompletionCallbackWithOutput< T > Class Template Reference

#include <completion_callback.h>

Inheritance diagram for pp::ext::ExtCompletionCallbackWithOutput< T >:

Collaboration diagram for pp::ext::ExtCompletionCallbackWithOutput< T >:

Public Types
typedef ::pp::internal::CompletionCallbackWithOutputBase < T, internal::ExtCallbackOutputTraits < T > >	BaseType
Public Types inherited from pp::internal::CompletionCallbackWithOutputBase< T, internal::ExtCallbackOutputTraits< T > >
typedef internal::ExtCallbackOutputTraits < T >::StorageType	OutputStorageType
typedef internal::ExtCallbackOutputTraits < T >::APIArgType	APIArgType
typedef internal::ExtCallbackOutputTraits < T >	TraitsType

Public Member Functions
	ExtCompletionCallbackWithOutput (typename BaseType::OutputStorageType *output)
	ExtCompletionCallbackWithOutput (PP_CompletionCallback_Func func, void *user_data, typename BaseType::OutputStorageType *output)
	ExtCompletionCallbackWithOutput (PP_CompletionCallback_Func func, void *user_data, int32_t flags, typename BaseType::OutputStorageType *output)
Public Member Functions inherited from pp::internal::CompletionCallbackWithOutputBase< T, internal::ExtCallbackOutputTraits< T > >
	CompletionCallbackWithOutputBase (OutputStorageType *output)
	CompletionCallbackWithOutputBase (PP_CompletionCallback_Func func, void *user_data, OutputStorageType *output)
	CompletionCallbackWithOutputBase (PP_CompletionCallback_Func func, void *user_data, int32_t flags, OutputStorageType *output)
APIArgType	output () const
Public Member Functions inherited from pp::CompletionCallback
	CompletionCallback ()
	CompletionCallback (PP_CompletionCallback_Func func, void *user_data)
	CompletionCallback (PP_CompletionCallback_Func func, void *user_data, int32_t flags)
void	set_flags (int32_t flags)
void	Run (int32_t result)
void	RunAndClear (int32_t result)
bool	IsOptional () const
const PP_CompletionCallback &	pp_completion_callback () const
int32_t	flags () const
int32_t	MayForce (int32_t result) const

Additional Inherited Members
Protected Attributes inherited from pp::CompletionCallback
PP_CompletionCallback	cc_

Detailed Description

template<typename T>
class pp::ext::ExtCompletionCallbackWithOutput< T >

ExtCompletionCallbackWithOutput is similar to CompletionCallbackWithOutput, but used by APIs within the pp::ext namespace. Usually it is used with the CompletionCallbackFactory's NewExtCallbackWithOutput.

Definition at line 304 of file completion_callback.h.

Member Typedef Documentation

template<typename T >

typedef ::pp::internal::CompletionCallbackWithOutputBase< T, internal::ExtCallbackOutputTraits<T> > pp::ext::ExtCompletionCallbackWithOutput< T >::BaseType

Definition at line 309 of file completion_callback.h.

Constructor & Destructor Documentation

template<typename T >

pp::ext::ExtCompletionCallbackWithOutput< T >::ExtCompletionCallbackWithOutput ( typename BaseType::OutputStorageType *  output )

inlineexplicit

The default constructor will create a blocking ExtCompletionCallbackWithOutput that references the given output data.

Parameters

[in]

output

A pointer to the data associated with the callback. The caller must ensure that this pointer outlives the completion callback. OutputStorageType is either ext::internal::ArrayVarOutputAdapterWithStorage<U> (if the template parameter T is of the form std::vector<U>) or ext::internal::VarOutputAdapterWithStorage<T> (otherwise).

Note: Blocking completion callbacks are only allowed from background threads.

Definition at line 324 of file completion_callback.h.

template<typename T >

pp::ext::ExtCompletionCallbackWithOutput< T >::ExtCompletionCallbackWithOutput ( PP_CompletionCallback_Func  func, void *  user_data, typename BaseType::OutputStorageType *  output  )

inline

A constructor for creating an ExtCompletionCallbackWithOutput that references the given output data.

Parameters

[in]	func	The function to be called on completion.
[in]	user_data	The user data to be passed to the callback function. This is optional and is typically used to help track state in case of multiple pending callbacks.
[in]	output	A pointer to the data associated with the callback. The caller must ensure that this pointer outlives the completion callback.

Definition at line 338 of file completion_callback.h.

template<typename T >

pp::ext::ExtCompletionCallbackWithOutput< T >::ExtCompletionCallbackWithOutput ( PP_CompletionCallback_Func  func, void *  user_data, int32_t  flags, typename BaseType::OutputStorageType *  output  )

inline

A constructor for creating an ExtCompletionCallbackWithOutput that references the given output data.

Parameters

[in]	func	The function to be called on completion.
[in]	user_data	The user data to be passed to the callback function. This is optional and is typically used to help track state in case of multiple pending callbacks.
[in]	flags	Bit field combination of PP_CompletionCallback_Flag flags used to control how non-NULL callbacks are scheduled by asynchronous methods.
[in]	output	A pointer to the data associated with the callback. The caller must ensure that this pointer outlives the completion callback.

Definition at line 359 of file completion_callback.h.

---

The documentation for this class was generated from the following file:

• completion_callback.h