201711.mbox/raw/%3cc8aa9813b98c4985ad62993081e512f6@git.apache.org%3e

 #ifndef PROTON_ERROR_H
 #define PROTON_ERROR_H 1

 /*
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreement
 s.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the

   * specific language governing permissions and limitations
  * under the License.
  *
  */

 #include <proton/import_export.h>
 #include <stdarg.h>

 ;
 #ifdef __cplusplus
 extern "C" {
 #endif

 typedef struct pn_error_t pn_error_t;
   45
 #define PN_OK (0)
 #define PN_EOS (-1)
 #define PN_ERR (-2)
 #define PN_OVERFLOW (-3)
   50 #define PN_UNDERFLOW (-4)
 #define PN_STATE_ERR (-5)
 #define PN_ARG_ERR (-6)
 #define PN_TIMEOUT (-7)
 #define PN_INTR (-8)
 #define PN_INPROGRESS (-9)
 #define PN_OUT_OF_MEMORY (-10)
 #define PN_ABORTED (-11)
 PN_EXTERN const char *pn_code(int code);

 PN_EXTERN pn_error_t *pn_error(void);

 PN_EXTERN void pn_error_free(pn_error_t *error);

 PN_EXTERN void pn_error_clear(pn_error_t *error);

 PN_EXTERN int pn_error_set(pn_error_t *error, int code, const char *text);

 PN_EXTERN int pn_error_vformat
 (pn_error_t *error, int code, const char *fmt, va_list ap);

 PN_EXTERN int pn_error_format(pn_error_t *error, int code, const char *fmt, ...);

 PN_EXTERN int pn_error_code(pn_error_t *error);

 PN_EXTERN const char *pn_error_text(pn_error_t *error);

 PN_EXTERN int pn_error_copy(pn_error_t *error, pn_error_t *src);

 #define PN_RETURN_IF_ERROR(x) \
 do {\
 int r = (x);\
 if (r < 0) return r; \
 } while (0)

 #ifdef __cplusplus
 }
 #endif

 #endif /* error.h */
pn_error_copy
int pn_error_copy(pn_error_t *error, pn_error_t *src)
Copy the src error.

+pn_error_set
int pn_error_set(pn_error_t *error, int code, const char *text)
Set the error code and text.

+pn_error_t
struct pn_error_t pn_error_t
An int error code and some string text to describe the error.
Definition: error.h:44

+pn_error_code
int pn_error_code(pn_error_t *error)
Get the the error code.

+pn_error
pn_error_t * pn_error(void)
Create an error object.

+pn_error_clear
void pn_error_clear(pn_error_t *error)
Reset the error to a "no error" state with code == 0.

+pn_error_format
int pn_error_format(pn_error_t *error, int code, const char *fmt,...)
Set the code and set the text using a printf-style formatted string.

+pn_error_free
void pn_error_free(pn_error_t *error)
Free an error object.

+pn_error_vformat
int pn_error_vformat(pn_error_t *error, int code, const char *fmt, va_list ap)
Set the code and set the text using a printf-style formatted string.

+pn_error_text
const char * pn_error_text(pn_error_t *error)
Get the error text.

+
+Typedefs
typedef struct pn_event_t	pn_event_t
	Notification of a state change in the protocol engine. More...

typedef struct pn_event_batch_t	pn_event_batch_t
	Unsettled API - A batch of events that must be handled in sequence. More...
+Enumerations
enum	pn_event_type_t { + PN_EVENT_NONE, +PN_REACTOR_INIT, +PN_REACTOR_QUIESCED, +PN_REACTOR_FINAL, + + PN_TIMER_TASK, +PN_CONNECTION_INIT, +PN_CONNECTION_BOUND, +PN_CONNECTION_UNBOUND, + + PN_CONNECTION_LOCAL_OPEN, +PN_CONNECTION_REMOTE_OPEN, +PN_CONNECTION_LOCAL_CLOSE, +PN_CONNECTION_REMOTE_CLOSE, + + PN_CONNECTION_FINAL, +PN_SESSION_INIT, +PN_SESSION_LOCAL_OPEN, +PN_SESSION_REMOTE_OPEN, + + PN_SESSION_LOCAL_CLOSE, +PN_SESSION_REMOTE_CLOSE, +PN_SESSION_FINAL, +PN_LINK_INIT, + + PN_LINK_LOCAL_OPEN, +PN_LINK_REMOTE_OPEN, +PN_LINK_LOCAL_CLOSE, +PN_LINK_REMOTE_CLOSE, + + PN_LINK_LOCAL_DETACH, +PN_LINK_REMOTE_DETACH, +PN_LINK_FLOW, +PN_LINK_FINAL, + + PN_DELIVERY, +PN_TRANSPORT, +PN_TRANSPORT_AUTHENTICATED, +PN_TRANSPORT_ERROR, + + PN_TRANSPORT_HEAD_CLOSED, +PN_TRANSPORT_TAIL_CLOSED, +PN_TRANSPORT_CLOSED, +PN_SELECTABLE_INIT, + + PN_SELECTABLE_UPDATED, +PN_SELECTABLE_READABLE, +PN_SELECTABLE_WRITABLE, +PN_SELECTABLE_ERROR, + + PN_SELECTABLE_EXPIRED, +PN_SELECTABLE_FINAL, +PN_CONNECTION_WAKE, +PN_LISTENER_ACCEPT, + + PN_LISTENER_CLOSE, +PN_PROACTOR_INTERRUPT, +PN_PROACTOR_TIMEOUT, +PN_PROACTOR_INACTIVE, + + PN_LISTENER_OPEN + + }
	An event type. More...
+Functions
const char *	pn_event_type_name (pn_event_type_t type)
	Get a human readable name for an event type. More...

pn_collector_t *	pn_collector (void)
	Construct a collector. More...

void	pn_collector_free (pn_collector_t *collector)
	Free a collector. More...

void	pn_collector_release (pn_collector_t *collector)
	Release a collector. More...

void	pn_collector_drain (pn_collector_t *collector)
	Drain a collector: remove and discard all events. More...

pn_event_t *	pn_collector_put (pn_collector_t collector, const pn_class_t clazz, void *context, pn_event_type_t type)
	Place a new event on a collector. More...

pn_event_t *	pn_collector_peek (pn_collector_t *collector)
	Access the head event contained by a collector. More...

bool	pn_collector_pop (pn_collector_t *collector)
	Remove the head event on a collector. More...

pn_event_t *	pn_collector_next (pn_collector_t *collector)
	Pop and return the head event, returns NULL if the collector is empty. More...

pn_event_t *	pn_collector_prev (pn_collector_t *collector)
	Return the same pointer as the most recent call to pn_collector_next(). More...

bool	pn_collector_more (pn_collector_t *collector)
	Check if there are more events after the current head event. More...

pn_event_type_t	pn_event_type (pn_event_t *event)
	Get the type of an event. More...

const pn_class_t *	pn_event_class (pn_event_t *event)
	Get the class associated with the event context. More...

+void *	pn_event_context (pn_event_t *event)
	Get the context associated with an event.

pn_connection_t *	pn_event_connection (pn_event_t *event)
	Get the connection associated with an event. More...

pn_session_t *	pn_event_session (pn_event_t *event)
	Get the session associated with an event. More...

pn_link_t *	pn_event_link (pn_event_t *event)
	Get the link associated with an event. More...

pn_delivery_t *	pn_event_delivery (pn_event_t *event)
	Get the delivery associated with an event. More...

pn_transport_t *	pn_event_transport (pn_event_t *event)
	Get the transport associated with an event. More...

pn_record_t *	pn_event_attachments (pn_event_t *event)
	Get any attachments associated with an event. More...

struct pn_condition_t *	pn_event_condition (pn_event_t *event)
	If the event context object has a condition and the condition is set return it, otherwise return NULL. More...

pn_event_t *	pn_event_batch_next (pn_event_batch_t *batch)
	Unsettled API - Remove the next event from the batch and return it. More...