async.h File Reference

NS/NIM IAsync* IPC wrapper. More...

#include "../types.h"
#include "../sf/service.h"
#include "../applets/error.h"
#include "../kernel/event.h"

Go to the source code of this file.

Data Structures
struct	AsyncValue
	AsyncValue. More...
struct	AsyncResult
	AsyncResult. More...

Functions
IAsyncValue
void	asyncValueClose (AsyncValue *a)
	Close a AsyncValue. More...
Result	asyncValueWait (AsyncValue *a, u64 timeout)
	Waits for the async operation to finish using the specified timeout. More...
Result	asyncValueGetSize (AsyncValue *a, u64 *size)
	Gets the value size. More...
Result	asyncValueGet (AsyncValue *a, void *buffer, size_t size)
	Gets the value. More...
Result	asyncValueCancel (AsyncValue *a)
	Cancels the async operation. More...
Result	asyncValueGetErrorContext (AsyncValue *a, ErrorContext *context)
	Gets the ErrorContext. More...
IAsyncResult
void	asyncResultClose (AsyncResult *a)
	Close a AsyncResult. More...
Result	asyncResultWait (AsyncResult *a, u64 timeout)
	Waits for the async operation to finish using the specified timeout. More...
Result	asyncResultGet (AsyncResult *a)
	Gets the Result. More...
Result	asyncResultCancel (AsyncResult *a)
	Cancels the async operation. More...
Result	asyncResultGetErrorContext (AsyncResult *a, ErrorContext *context)
	Gets the ErrorContext. More...

Detailed Description

NS/NIM IAsync* IPC wrapper.

Author

yellows8

Copyright

libnx Authors

Function Documentation

asyncResultCancel()

Result asyncResultCancel

(

AsyncResult *

a

)

Cancels the async operation.

Note

Used automatically by asyncResultClose.

Parameters

a	AsyncResult

asyncResultClose()

void asyncResultClose

(

AsyncResult *

a

)

Close a AsyncResult.

Note

When the object is initialized, this uses asyncResultCancel then asyncResultWait with timeout=UINT64_MAX.

Parameters

a	AsyncResult

asyncResultGet()

Result asyncResultGet

(

AsyncResult *

a

)

Gets the Result.

Note

Prior to using the cmd, this uses asyncResultWait with timeout=UINT64_MAX.

Parameters

a	AsyncResult

asyncResultGetErrorContext()

Result asyncResultGetErrorContext	(	AsyncResult *	a,
		ErrorContext *	context
	)

Gets the ErrorContext.

Note

Only available on [4.0.0+].

Parameters

	a	AsyncResult
[out]	context	ErrorContext

asyncResultWait()

Result asyncResultWait	(	AsyncResult *	a,
		u64	timeout
	)

Waits for the async operation to finish using the specified timeout.

Parameters

	a	AsyncResult
[in]	timeout	Timeout in nanoseconds. UINT64_MAX for no timeout.

asyncValueCancel()

Result asyncValueCancel

(

AsyncValue *

a

)

Cancels the async operation.

Note

Used automatically by asyncValueClose.

Parameters

a	AsyncValue

asyncValueClose()

void asyncValueClose

(

AsyncValue *

a

)

Close a AsyncValue.

Note

When the object is initialized, this uses asyncValueCancel then asyncValueWait with timeout=UINT64_MAX.

Parameters

a	AsyncValue

asyncValueGet()

Result asyncValueGet	(	AsyncValue *	a,
		void *	buffer,
		size_t	size
	)

Gets the value.

Note

Prior to using the cmd, this uses asyncResultWait with timeout=UINT64_MAX.

Parameters

	a	AsyncValue
[out]	buffer	Output buffer.
[in]	size	Output buffer size.

asyncValueGetErrorContext()

Result asyncValueGetErrorContext	(	AsyncValue *	a,
		ErrorContext *	context
	)

Gets the ErrorContext.

Note

Only available on [4.0.0+].

Parameters

	a	AsyncValue
[out]	context	ErrorContext

asyncValueGetSize()

Result asyncValueGetSize	(	AsyncValue *	a,
		u64 *	size
	)

Gets the value size.

Parameters

	a	AsyncValue
[out]	size	Output size.

asyncValueWait()

Result asyncValueWait	(	AsyncValue *	a,
		u64	timeout
	)

Waits for the async operation to finish using the specified timeout.

Parameters

	a	AsyncValue
[in]	timeout	Timeout in nanoseconds. UINT64_MAX for no timeout.