messenger.h

Go to the documentation of this file.

#ifndef PROTON_MESSENGER_H
#define PROTON_MESSENGER_H 1
 
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  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 <proton/message.h>
#include <proton/selectable.h>
#include <proton/link.h>
#include <proton/transport.h>
#include <proton/ssl.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct pn_messenger_t pn_messenger_t;
 
typedef struct pn_subscription_t pn_subscription_t;
 
typedef int64_t pn_tracker_t;
 
typedef enum {
  PN_STATUS_UNKNOWN = 0, 
  PN_STATUS_PENDING = 1, 
  PN_STATUS_ACCEPTED = 2, 
  PN_STATUS_REJECTED = 3, 
  PN_STATUS_RELEASED = 4, 
  PN_STATUS_MODIFIED = 5, 
  PN_STATUS_ABORTED = 6, 
  PN_STATUS_SETTLED = 7 
} pn_status_t;
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_messenger_t *pn_messenger(const char *name);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN const char *pn_messenger_name(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_certificate(pn_messenger_t *messenger, const char *certificate);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN const char *pn_messenger_get_certificate(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_private_key(pn_messenger_t *messenger, const char *private_key);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN const char *pn_messenger_get_private_key(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_password(pn_messenger_t *messenger, const char *password);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN const char *pn_messenger_get_password(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_trusted_certificates(pn_messenger_t *messenger, const char *cert_db);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN const char *pn_messenger_get_trusted_certificates(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_timeout(pn_messenger_t *messenger, int timeout);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_get_timeout(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN bool pn_messenger_is_blocking(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_blocking(pn_messenger_t *messenger, bool blocking);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN bool pn_messenger_is_passive(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_passive(pn_messenger_t *messenger, bool passive);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN void pn_messenger_free(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_errno(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_error_t *pn_messenger_error(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_get_outgoing_window(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_outgoing_window(pn_messenger_t *messenger, int window);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_get_incoming_window(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_incoming_window(pn_messenger_t *messenger,
                                               int window);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_start(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_stop(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN bool pn_messenger_stopped(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_subscription_t *pn_messenger_subscribe(pn_messenger_t *messenger, const char *source);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_subscription_t *
pn_messenger_subscribe_ttl(pn_messenger_t *messenger, const char *source,
                           pn_seconds_t timeout);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_link_t *pn_messenger_get_link(pn_messenger_t *messenger,
                                           const char *address, bool sender);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN void *pn_subscription_get_context(pn_subscription_t *sub);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN void pn_subscription_set_context(pn_subscription_t *sub, void *context);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN const char *pn_subscription_address(pn_subscription_t *sub);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_put(pn_messenger_t *messenger, pn_message_t *msg);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_status_t pn_messenger_status(pn_messenger_t *messenger, pn_tracker_t tracker);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_delivery_t *pn_messenger_delivery(pn_messenger_t *messenger,
                                               pn_tracker_t tracker);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN bool pn_messenger_buffered(pn_messenger_t *messenger, pn_tracker_t tracker);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_settle(pn_messenger_t *messenger, pn_tracker_t tracker, int flags);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_tracker_t pn_messenger_outgoing_tracker(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_work(pn_messenger_t *messenger, int timeout);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_interrupt(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_send(pn_messenger_t *messenger, int n);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_recv(pn_messenger_t *messenger, int limit);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_receiving(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_get(pn_messenger_t *messenger, pn_message_t *message);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_tracker_t pn_messenger_incoming_tracker(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_subscription_t *pn_messenger_incoming_subscription(pn_messenger_t *messenger);
 
#define PN_CUMULATIVE (0x1)
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_accept(pn_messenger_t *messenger, pn_tracker_t tracker, int flags);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_reject(pn_messenger_t *messenger, pn_tracker_t tracker, int flags);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_link_t *pn_messenger_tracker_link(pn_messenger_t *messenger,
                                               pn_tracker_t tracker);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_outgoing(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_incoming(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_route(pn_messenger_t *messenger, const char *pattern,
                                 const char *address);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_rewrite(pn_messenger_t *messenger, const char *pattern,
                                   const char *address);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_selectable_t *pn_messenger_selectable(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_timestamp_t pn_messenger_deadline(pn_messenger_t *messenger);
 
#define PN_FLAGS_CHECK_ROUTES                                                   \
  (0x1) 
#define PN_FLAGS_ALLOW_INSECURE_MECHS                                           \
  (0x2) 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_flags(pn_messenger_t *messenger,
                                     const int flags);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_get_flags(pn_messenger_t *messenger);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_snd_settle_mode(pn_messenger_t *messenger,
                                               const pn_snd_settle_mode_t mode);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int pn_messenger_set_rcv_settle_mode(pn_messenger_t *messenger,
                                               const pn_rcv_settle_mode_t mode);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN void pn_messenger_set_tracer(pn_messenger_t *messenger,
                                       pn_tracer_t tracer);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN pn_millis_t
    pn_messenger_get_remote_idle_timeout(pn_messenger_t *messenger,
                                         const char *address);
 
PN_DEPRECATED("Use the Proactor API or Qpid Proton C++")
PNX_EXTERN int
pn_messenger_set_ssl_peer_authentication_mode(pn_messenger_t *messenger,
                                              const pn_ssl_verify_mode_t mode);
 
#ifdef __cplusplus
}
#endif
 
#endif /* messenger.h */