.\" Automatically generated by Pandoc 2.17.1.1
.\"
.TH "VDM_FLUSH" "3" "2022-09-04" "MINIASYNC - miniasync version 0.2.1" "MINIASYNC Programmer's Manual"
.hy
.\" SPDX-License-Identifier: BSD-3-Clause
.\" Copyright 2020-2022, Intel Corporation
.SH NAME
.PP
\f[B]vdm_flush\f[R]() - create a new flush virtual data mover operation
structure
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <libminiasync.h>

struct vdm_operation_output_flush {
    uint64_t unused;
};

FUTURE(vdm_operation_future,
    struct vdm_operation_data, struct vdm_operation_output);

struct vdm_operation_future vdm_flush(struct vdm *vdm, void *dest, size_t n, uint64_t flags);
\f[R]
.fi
.PP
For general description of virtual data mover API, see
\f[B]miniasync_vdm\f[R](7).
.SH DESCRIPTION
.PP
\f[B]vdm_flush\f[R]() initializes and returns a new flush future based
on the virtual data mover implementation instance \f[I]vdm\f[R].
The parameters: \f[I]dest\f[R], \f[I]n\f[R] are standard flush
parameters.
The \f[I]flags\f[R] represents data mover specific flags.
The \f[B]flush\f[R] operation is implemented only for the DML data mover
and cannot be used with synchronous and thread data movers.
.PP
Flush future obtained using \f[B]vdm_flush\f[R]() will attempt to flush
the \f[I]n\f[R] bytes of the processor caches at the \f[I]dest\f[R]
address when its polled.
.SS RETURN VALUE
.PP
The \f[B]vdm_flush\f[R]() function returns an initialized \f[I]struct
vdm_operation_future\f[R] flush future.
.SH SEE ALSO
.PP
\f[B]vdm_memcpy\f[R](3), \f[B]vdm_memmove\f[R](3),
\f[B]vdm_memset\f[R](3), \f[B]miniasync\f[R](7),
\f[B]miniasync_vdm\f[R](7), \f[B]miniasync_vdm_dml\f[R](7) and
\f[B]<https://pmem.io>\f[R]