sp_make_swap_out_job

March 26, 2020 Contributors

Name

sp_make_swap_out_job — Create and return a job that will manage swap out processing

Synopsis

#include "sp_async.h"

| ec_async_job * **sp_make_swap_out_job** ( | ac, |   |
|   | ctx, |   |
|   | mess, |   |
|   | samfunc, |   |
|   | info); |   |

accept_construct * <var class="pdparam">ac</var>;
validate_context * <var class="pdparam">ctx</var>;
ec_message * <var class="pdparam">mess</var>;
sp_async_swapout_samfunc <var class="pdparam">samfunc</var>;
void * <var class="pdparam">info</var>;

Description

Note

This reference page was automatically generated from functions found in the header files in the development branch. The function described here may not exist in generally available versions of Momentum, and may change in behavior when it is generally available. Consult your vendor for definitive advice on the use of this function.

Create and return a job that will manage swap out processing.

Allocates and fills out a job that will perform internal swap out processing, and that will call back to the supplied samfunc to expand the recipient list to multiple messages.

The returned job is set to run in the SWAPOUT pool and has no completion options set. The job will be automatically freed on completion.

The intended use is for the caller to update the completion options, for example, to arrange for resumption of some other processing.

Parameters

ac

the accept construct for the session

ctx

the validate_context for the session

mess

the message (may be NULL)

samfunc

an optional function to use to expand batched recipients

info

a parameter that will be passed to the samfunc

Return Values

an ec_async_job or NULL if insufficient memory was available.