diff options
author | file <file@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-05-29 15:43:16 +0000 |
---|---|---|
committer | file <file@f38db490-d61c-443f-a65b-d21fe96a405b> | 2007-05-29 15:43:16 +0000 |
commit | c6fc46db2951a1dee57342c5fb810fc84abee26f (patch) | |
tree | 37e1e1996e052abeb951d4394aae93854250ad2a | |
parent | ee7fe295c695161e93eaee489913327a1160bf6f (diff) |
Update datastores documentation. (issue #9801 reported by mnicholson)
git-svn-id: http://svn.digium.com/svn/asterisk/branches/1.4@66398 f38db490-d61c-443f-a65b-d21fe96a405b
-rw-r--r-- | doc/datastores.txt | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/doc/datastores.txt b/doc/datastores.txt index a3aa9c27f..64b5d35cc 100644 --- a/doc/datastores.txt +++ b/doc/datastores.txt @@ -22,9 +22,8 @@ This is a needed structure that contains information about a datastore, it's use 1. Use ast_channel_datastore_alloc function to return a pre-allocated structure Ex: datastore = ast_channel_datastore_alloc(&example_datastore, "uid"); This function takes two arguments: (datastore info structure, uid) -2. Attach data and destroy callback to pre-allocated structure. +2. Attach data to pre-allocated structure. Ex: datastore->data = mysillydata; - datastore->destroy = callback_destroy; 3. Add datastore to the channel Ex: ast_channel_datastore_add(chan, datastore); This function takes two arguments: (pointer to channel, pointer to data store) @@ -33,13 +32,12 @@ Full Example: void callback_destroy(void *data) { - free(data); + ast_free(data); } struct ast_datastore *datastore = NULL; datastore = ast_channel_datastore_alloc(&example_datastore, NULL); datastore->data = mysillydata; -datastore->destroy = callback_destroy; ast_channel_datastore_add(chan, datastore); NOTE: Because you're passing a pointer to a function in your module, you'll want to include @@ -53,11 +51,8 @@ this in your use count. When allocated increment, when destroyed decrement. 2. Remove the data store from the channel Ex: ast_channel_datastore_remove(chan, datastore); This function takes two arguments: (pointer to channel, pointer to data store) -3. If we want to now, free the memory or do stuff to the data on the data store - If we do then we will want to unset the data and callback - Ex: datastore->data = NULL; - datastore->destroy = NULL; -4. Free the data store +3. If we want to now do stuff to the data on the data store +4. Free the data store (this will call the destroy call back) Ex: ast_channel_datastore_free(datastore); This function takes one argument: (pointer to data store) |