OpFlex Framework  1.3.0
offramework_c.h
Go to the documentation of this file.
1 /* -*- C -*-; c-basic-offset: 4; indent-tabs-mode: nil */
6 /*
7  * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
8  *
9  * This program and the accompanying materials are made available under the
10  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
11  * and is available at http://www.eclipse.org/legal/epl-v10.html
12  */
13 
14 #include "ofcore_c.h"
15 
16 #ifndef OPFLEX_C_OFFRAMEWORK_H
17 #define OPFLEX_C_OFFRAMEWORK_H
18 
40 
41 /* @} cmetadata */
42 
55 
60 
61 #ifdef __cplusplus
62 extern "C" {
63 #endif
64 
73  ofstatus offramework_create(/* out */ offramework_p* framework);
74 
82  ofstatus offramework_destroy(/* out */ offramework_p* framework);
83 
93  ofmetadata_p metadata);
94 
106  const char* name,
107  const char* domain);
108 
117 
125 
145  const char* hostname, int port);
146 
156 
157 #ifdef __cplusplus
158 } /* extern "C" */
159 #endif
160 
165 #endif /* OPFLEX_C_OFFRAMEWORK_H */
ofstatus offramework_add_peer(offramework_p framework, const char *hostname, int port)
Add an OpFlex peer.
ofobj_p ofpeerstatuslistener_p
A pointer to peer status listener object.
Definition: offramework_c.h:59
ofobj_p ofmetadata_p
A pointer to a generated model metadata object.
Definition: offramework_c.h:39
ofstatus offramework_start(offramework_p framework)
Start the framework.
ofstatus offramework_set_model(offramework_p framework, ofmetadata_p metadata)
Add the given model metadata to the managed object database.
ofstatus offramework_register_peerstatuslistener(offramework_p framework, ofpeerstatuslistener_p obj)
register to listen to opflex peer connection status and health
ofobj_p offramework_p
A pointer to an OF framework object.
Definition: offramework_c.h:54
ofstatus offramework_stop(offramework_p framework)
Cleanly stop the framework.
void * ofobj_p
Base type for all OpFlex object pointers.
Definition: ofcore_c.h:89
ofstatus offramework_create(offramework_p *framework)
Create a new OF framework instance.
ofstatus offramework_set_opflex_identity(offramework_p framework, const char *name, const char *domain)
Set the opflex identity information for this framework instance.
ofstatus offramework_destroy(offramework_p *framework)
Destroy a OF Framework instance, and zero the pointer.
C wrapper core defininitions.
int ofstatus
An opflex status code.
Definition: ofcore_c.h:84