Diffusion C API  6.4.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
registration.h File Reference

Typedefs

typedef struct
DIFFUSION_REGISTRATION_T 
DIFFUSION_REGISTRATION_T
 A reference to a registered handler. More...
 

Functions

void diffusion_registration_close (SESSION_T *session, const DIFFUSION_REGISTRATION_T *registration)
 Request that the handler is unregistered from the server. More...
 
DIFFUSION_REGISTRATION_Tdiffusion_registration_dup (const DIFFUSION_REGISTRATION_T *registration)
 Returna a copy of a DIFFUSION_REGISTRATION_T. More...
 
void diffusion_registration_free (DIFFUSION_REGISTRATION_T *registration)
 Free a memory allocated DIFFUSION_REGISTRATION_T More...
 

Typedef Documentation

A reference to a registered handler.

Such a handler reference is provided whenever a handler with a server side presence is registered.

Function Documentation

void diffusion_registration_close ( SESSION_T session,
const DIFFUSION_REGISTRATION_T registration 
)

Request that the handler is unregistered from the server.

After the handler is unregistered, the handler's on_close function will be called.

Parameters
sessionThe session handle. If NULL, this function returns immediately.
registrationThe handler registration. If NULL, this function returns immediately.
DIFFUSION_REGISTRATION_T* diffusion_registration_dup ( const DIFFUSION_REGISTRATION_T registration)

Returna a copy of a DIFFUSION_REGISTRATION_T.

diffusion_registration_free should be called on the pointer when no longer needed.

Parameters
registrationdiffusion registration to be copied.
Returns
a copy of a DIFFUSION_REGISTRATION_T. NULL, if registration is NULL.
void diffusion_registration_free ( DIFFUSION_REGISTRATION_T registration)

Free a memory allocated DIFFUSION_REGISTRATION_T

Parameters
registrationthe DIFFUSION_REGISTRATION_T to be freed.