mmr_disconnect()

Disconnect from mm-renderer.

Synopsis:

#include <mm/renderer/renderer.h>
 
void mmr_disconnect(mmr_connection_t *connection)

Since:

BlackBerry 10.0.0

Arguments:

connection

An mm-renderer connection handle.

Library:

libmmrndclient (For the qcc command, use the -l mrndclient option to link against this library)

Description:

Disconnect from mm-renderer. Close any existing context handles associated with the connection being closed and free their memory.

Each context handle is associated with the connection handle used to create it. This means that if you have multiple connections to mm-renderer, calling mmr_disconnect() to close one of those connections doesn't necessarily close all your context handles.

You shouldn't use these handles again, not even in an API call to close them. If any of them are primary handles, their contexts also get destroyed.

The same happens in terms of contexts being destroyed if your application exits without explicitly disconnecting. This means you don't have to clean up old contexts when you restart the application.

This function is asynchronous, and may return before the destruction of any related contexts is complete. Calling mmr_context_destroy() for each context associated with the connection ensures that the context is destroyed before returning.

Returns:

Last modified: 2014-06-24



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus