Error handling cleanup
[radsecproxy.git] / lib / include / radsec / radsec.h
index dd784cc..75ed522 100644 (file)
@@ -11,14 +11,18 @@ enum rs_err_code {
     RSE_INVALID_CTX = 3,
     RSE_INVALID_CONN = 4,
     RSE_CONN_TYPE_MISMATCH = 5,
-    RSE_FR = 6,
+    RSE_FR = 6,                        /* FreeRADIUS error.  */
     RSE_BADADDR = 7,
     RSE_NOPEER = 8,
-    RSE_EVENT = 9,
-    RSE_CONNERR = 10,
+    RSE_EVENT = 9,             /* libevent error.  */
+    RSE_SOCKERR = 10,
     RSE_CONFIG = 11,
     RSE_BADAUTH = 12,
-    RSE_SOME_ERROR = 21,
+    RSE_INTERNAL = 13,
+    RSE_SSLERR = 14,           /* OpenSSL error.  */
+    RSE_INVALID_PKT = 15,
+    RSE_IOTIMEOUT = 16,
+    RSE_INVAL = 17,
 };
 
 enum rs_conn_type {
@@ -31,6 +35,10 @@ enum rs_conn_type {
 typedef unsigned int rs_conn_type_t;
 
 
+#if defined (__cplusplus)
+extern "C" {
+#endif
+
 /* Data types.  */
 struct rs_context;             /* radsec-impl.h */
 struct rs_connection;          /* radsec-impl.h */
@@ -54,10 +62,9 @@ struct rs_alloc_scheme {
 };
 
 typedef void (*rs_conn_connected_cb) (void *user_data /* FIXME: peer? */ );
-typedef void (*rs_conn_disconnected_cb) (void *user_data
-                                        /* FIXME: reason? */ );
-typedef void (*rs_conn_packet_received_cb) (const struct rs_packet *
-                                           packet, void *user_data);
+typedef void (*rs_conn_disconnected_cb) (void *user_data /* FIXME: reason? */ );
+typedef void (*rs_conn_packet_received_cb) (struct rs_packet *packet,
+                                           void *user_data);
 typedef void (*rs_conn_packet_sent_cb) (void *user_data);
 struct rs_conn_callbacks {
     /** Callback invoked when the connection has been established.  */
@@ -77,73 +84,92 @@ int rs_context_create(struct rs_context **ctx, const char *dict);
 void rs_context_destroy(struct rs_context *ctx);
 int rs_context_set_alloc_scheme(struct rs_context *ctx,
                                struct rs_alloc_scheme *scheme);
-int rs_context_read_config(struct rs_context *ctx,
-                          const char *config_file);
+int rs_context_read_config(struct rs_context *ctx, const char *config_file);
 
 /* Connection.  */
-int rs_conn_create(struct rs_context *ctx, struct rs_connection **conn,
+int rs_conn_create(struct rs_context *ctx,
+                  struct rs_connection **conn,
                   const char *config);
 void rs_conn_set_type(struct rs_connection *conn, rs_conn_type_t type);
-int rs_conn_add_listener(struct rs_connection *conn, rs_conn_type_t type,
-                        const char *hostname, int port);
-void rs_conn_destroy(struct rs_connection *conn);
-int rs_conn_set_eventbase(struct rs_connection *conn,
-                         struct event_base *eb);
-int rs_conn_set_callbacks(struct rs_connection *conn,
-                         struct rs_conn_callbacks *cb);
-struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection
-                                               *conn);
-int rs_conn_select_server(struct rs_connection *conn, const char *name);
-int rs_conn_get_current_server(struct rs_connection *conn,
-                              const char *name, size_t buflen);
+int rs_conn_add_listener(struct rs_connection *conn,
+                        rs_conn_type_t type,
+                        const char *hostname,
+                        int port);
+int rs_conn_disconnect (struct rs_connection *conn);
+int rs_conn_destroy(struct rs_connection *conn);
+int rs_conn_set_eventbase(struct rs_connection *conn, struct event_base *eb);
+void rs_conn_set_callbacks(struct rs_connection *conn,
+                          struct rs_conn_callbacks *cb);
+void rs_conn_del_callbacks(struct rs_connection *conn);
+struct rs_conn_callbacks *rs_conn_get_callbacks(struct rs_connection *conn);
+int rs_conn_select_peer(struct rs_connection *conn, const char *name);
+int rs_conn_get_current_peer(struct rs_connection *conn,
+                            const char *name,
+                            size_t buflen);
 int rs_conn_receive_packet(struct rs_connection *conn,
                           struct rs_packet *request,
                           struct rs_packet **pkt_out);
 int rs_conn_fd(struct rs_connection *conn);
 
-/* Server and client.  */
-int rs_server_create(struct rs_connection *conn, struct rs_peer **server);
-int rs_server_set_address(struct rs_peer *server, const char *hostname,
-                         const char *service);
-int rs_server_set_secret(struct rs_peer *server, const char *secret);
-void rs_server_set_timeout(struct rs_peer *server, int timeout);
-void rs_server_set_tries(struct rs_peer *server, int tries);
+/* Peer -- client and server.  */
+int rs_peer_create(struct rs_connection *conn, struct rs_peer **peer_out);
+int rs_peer_set_address(struct rs_peer *peer, const char *hostname,
+                       const char *service);
+int rs_peer_set_secret(struct rs_peer *peer, const char *secret);
+void rs_peer_set_timeout(struct rs_peer *peer, int timeout);
+void rs_peer_set_retries(struct rs_peer *peer, int retries);
 
 /* Packet.  */
-int rs_packet_create_acc_request(struct rs_connection *conn,
-                                struct rs_packet **pkt,
-                                const char *user_name,
-                                const char *user_pw);
+int rs_packet_create(struct rs_connection *conn, struct rs_packet **pkt_out);
 void rs_packet_destroy(struct rs_packet *pkt);
 void rs_packet_add_attr(struct rs_packet *pkt, struct rs_attr *attr);
 int rs_packet_send(struct rs_packet *pkt, void *data);
 struct radius_packet *rs_packet_frpkt(struct rs_packet *pkt);
+int rs_packet_create_authn_request(struct rs_connection *conn,
+                                  struct rs_packet **pkt,
+                                  const char *user_name,
+                                  const char *user_pw);
 
 /* Attribute.  */
 /* FIXME: Replace (or complement) with a wrapper for paircreate().  */
-int rs_attr_create(struct rs_connection *conn, struct rs_attr **attr,
-                  const char *type, const char *val);
+int rs_attr_create(struct rs_connection *conn,
+                  struct rs_attr **attr,
+                  const char *type,
+                  const char *val);
 void rs_attr_destroy(struct rs_attr *attr);
 
 /* Config.  */
-struct rs_realm *rs_conf_find_realm(struct rs_context *ctx,
-                                   const char *name);
+struct rs_realm *rs_conf_find_realm(struct rs_context *ctx, const char *name);
 
 /* Error.  */
-int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt,
-                   ...);
-int rs_err_ctx_push_fl(struct rs_context *ctx, int code, const char *file,
-                      int line, const char *fmt, ...);
+int rs_err_ctx_push(struct rs_context *ctx, int code, const char *fmt, ...);
+int rs_err_ctx_push_fl(struct rs_context *ctx,
+                      int code,
+                      const char *file,
+                      int line,
+                      const char *fmt,
+                      ...);
 struct rs_error *rs_err_ctx_pop(struct rs_context *ctx);
-int rs_err_conn_push(struct rs_connection *conn, int code, const char *fmt,
+int rs_err_conn_push(struct rs_connection *conn,
+                    int code,
+                    const char *fmt,
                     ...);
-int rs_err_conn_push_fl(struct rs_connection *conn, int code,
-                       const char *file, int line, const char *fmt, ...);
+int rs_err_conn_push_fl(struct rs_connection *conn,
+                       int code,
+                       const char *file,
+                       int line,
+                       const char *fmt,
+                       ...);
 struct rs_error *rs_err_conn_pop(struct rs_connection *conn);
+int rs_err_conn_peek_code (struct rs_connection *conn);
 void rs_err_free(struct rs_error *err);
 char *rs_err_msg(struct rs_error *err, int dofree_flag);
 int rs_err_code(struct rs_error *err, int dofree_flag);
 
+#if defined (__cplusplus)
+}
+#endif
+
 /* Local Variables: */
 /* c-file-style: "stroustrup" */
 /* End: */