junos_kcom_pub_blob.h File Reference

Definitions for public blobs and the functions used to work with them. More...


Data Structures

struct  junos_kcom_pub_ssrb_s
 junos_kcom_pub_ssrb_t is a structure used for the SSRB public blob. More...
struct  junos_kcom_pub_blob_s
 junos_kcom_pub_blob_t is the structure used for all the public blobs. More...
struct  junos_kcom_pub_blob_key_s
 junos_kcom_pub_blob_key_t is a structure used as a key for all the public blobs. More...
struct  junos_kcom_pub_blob_msg_s
 junos_kcom_pub_blob_msg_t structure is used to notify the users about the asynchronus events happening on the public blob they have registered for. More...
struct  junos_kcom_pub_blob_req_s
 junos_kcom_pub_blob_req_t is a structure used to register, deregister and retrieve the blobs of a particular type. More...

Typedefs

typedef junos_kcom_pub_ssrb_s junos_kcom_pub_ssrb_t
 junos_kcom_pub_ssrb_t is a structure used for the SSRB public blob.
typedef junos_kcom_pub_blob_s junos_kcom_pub_blob_t
 junos_kcom_pub_blob_t is the structure used for all the public blobs.
typedef junos_kcom_pub_blob_key_s junos_kcom_pub_blob_key_t
 junos_kcom_pub_blob_key_t is a structure used as a key for all the public blobs.
typedef junos_kcom_pub_blob_msg_s junos_kcom_pub_blob_msg_t
 junos_kcom_pub_blob_msg_t structure is used to notify the users about the asynchronus events happening on the public blob they have registered for.
typedef int junos_kcom_pub_msg_handler_ptr __P ((junos_kcom_pub_blob_msg_t *, void *))
 junos_kcom_pub_msg_handler_ptr is a user-supplied function called to give async notifications to the users.
typedef junos_kcom_pub_blob_req_s junos_kcom_pub_blob_req_t
 junos_kcom_pub_blob_req_t is a structure used to register, deregister and retrieve the blobs of a particular type.

Enumerations

enum  junos_kcom_pub_blob_req_opcode_t { JUNOS_KCOM_PUB_BLOB_REG, JUNOS_KCOM_PUB_BLOB_DEREG, JUNOS_KCOM_PUB_BLOB_GET_ALL }
 junos_kcom_pub_blob_opcode_t is an enum defining the type of operations which can be done on the public blobs. More...
enum  junos_kcom_pub_blob_msg_opcode_t { JUNOS_KCOM_PUB_BLOB_MSG_ADD, JUNOS_KCOM_PUB_BLOB_MSG_DEL, JUNOS_KCOM_PUB_BLOB_MSG_CHANGE }
 junos_kcom_pub_blob_msg_opcode_t defines the types of operations that can be done on the public blobs. More...

Functions

int junos_kcom_pub_blob_req (junos_kcom_pub_blob_req_t *req)
 API to request all possible operations for the public blobs.
void junos_kcom_free_pub_blob (junos_kcom_pub_blob_t *pub_blob)
 API to free the public blob structure passed to the applications in GET-ALL operations.
void junos_kcom_free_pub_msg (junos_kcom_pub_blob_msg_t *msg)
 API to free the public blob messge strucuture passed to the applications during async notifications.


Detailed Description

Definitions for public blobs and the functions used to work with them.


Typedef Documentation

typedef int kcom_handler_ptr __P((void *, void *))
 

junos_kcom_pub_msg_handler_ptr is a user-supplied function called to give async notifications to the users.

The notifications can be for adding, deletion, and modification of the registered public blob.

typedef struct junos_kcom_pub_blob_msg_s junos_kcom_pub_blob_msg_t
 

junos_kcom_pub_blob_msg_t structure is used to notify the users about the asynchronus events happening on the public blob they have registered for.

Operations can be ADD, DELETE, and CHANGE, as defined in the junos_kcom_pub_blob_msg_opcode_t enum.

typedef struct junos_kcom_pub_blob_s junos_kcom_pub_blob_t
 

junos_kcom_pub_blob_t is the structure used for all the public blobs.

This is the interface used to get the information for the various public blobs.


Enumeration Type Documentation

enum junos_kcom_pub_blob_msg_opcode_t
 

junos_kcom_pub_blob_msg_opcode_t defines the types of operations that can be done on the public blobs.

This is the part of the message structure used for async public blob notifications.

Enumerator:
JUNOS_KCOM_PUB_BLOB_MSG_ADD  A new blob has been added.
JUNOS_KCOM_PUB_BLOB_MSG_DEL  A blob has been deleted.
JUNOS_KCOM_PUB_BLOB_MSG_CHANGE  A blob has been modifed.

enum junos_kcom_pub_blob_req_opcode_t
 

junos_kcom_pub_blob_opcode_t is an enum defining the type of operations which can be done on the public blobs.

Use these values when calling the API junos_kcom_pub_blob_req().

Enumerator:
JUNOS_KCOM_PUB_BLOB_REG  Register the handler for public blob.
JUNOS_KCOM_PUB_BLOB_DEREG  Deregister the handler for public blob.
JUNOS_KCOM_PUB_BLOB_GET_ALL  Get all the blobs for a particular blob.


Function Documentation

void junos_kcom_free_pub_blob junos_kcom_pub_blob_t pub_blob  ) 
 

API to free the public blob structure passed to the applications in GET-ALL operations.

Parameters:
[in] pub_blob Pointer to junos_kcom_pub_blob_t structure.
Returns:
Doesn't return any value

void junos_kcom_free_pub_msg junos_kcom_pub_blob_msg_t msg  ) 
 

API to free the public blob messge strucuture passed to the applications during async notifications.

Parameters:
[in] msg Pointer to junos_kcom_pub_blob_msg_t structure.
Returns:
Doesn't return any value

int junos_kcom_pub_blob_req junos_kcom_pub_blob_req_t req  ) 
 

API to request all possible operations for the public blobs.

The application can register, degregister or retrieve the public blobs of a particular type through this function.

Parameters:
[in] req Pointer to junos_kcom_pub_blob_req_t structure.
[out] svc_set_info Structure which defines the service set related info.
Returns:
The possible return values are:
  • KCOM_OK The operation completed without any errors.
  • KCOM_LIB_ERR There was an error.
  • KCOM_ITER_END The user handler aborted the get all operation.


2007-2009 Juniper Networks, Inc. All rights reserved. The information contained herein is confidential information of Juniper Networks, Inc., and may not be used, disclosed, distributed, modified, or copied without the prior written consent of Juniper Networks, Inc. in an express license. This information is subject to change by Juniper Networks, Inc. Juniper Networks, the Juniper Networks logo, and JUNOS are registered trademarks of Juniper Networks, Inc. in the United States and other countries. All other trademarks, service marks, registered trademarks, or registered service marks are the property of their respective owners.
Generated on Sun May 30 20:23:49 2010 for libjunos-sdk by Doxygen 1.4.5