pt_client_api.h

Go to the documentation of this file.

/*
 * ----------------------------------------------------------------------------
 * Copyright 2019 ARM Ltd.
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed 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.
 * ----------------------------------------------------------------------------
 */

#ifndef PT_API_VERSION
#define PT_API_VERSION 2
#endif
#if PT_API_VERSION != 2
#error "Including mixed versions of Protocol API"
#endif

#ifndef PT_CLIENT_API_H
#define PT_CLIENT_API_H

#include "pt-client-2/pt_common_api.h"

int pt_api_init();

typedef void (*pt_response_handler)(void *userdata);

typedef void (*pt_connection_ready_cb)(connection_id_t connection_id, const char *name, void *userdata);

typedef void (*pt_disconnected_cb)(connection_id_t connection_id, void *userdata);

typedef void (*pt_connection_shutdown_cb)(connection_id_t connection_id, void *userdata);

typedef void (*pt_certificate_renewal_notification_handler)(const connection_id_t connection_id,
                                                            const char *name,
                                                            int32_t initiator,
                                                            int32_t status,
                                                            const char *description,
                                                            void *userdata);

typedef struct protocol_translator_callbacks {
    pt_connection_ready_cb connection_ready_cb;
    pt_disconnected_cb disconnected_cb;
    pt_connection_shutdown_cb connection_shutdown_cb;
    pt_certificate_renewal_notification_handler certificate_renewal_notifier_cb;
} protocol_translator_callbacks_t;

pt_client_t *pt_client_create(const char *socket_path,
                              const protocol_translator_callbacks_t *pt_cbs);

void pt_client_free(pt_client_t *client);

connection_id_t pt_client_get_connection_id(pt_client_t *client);

int pt_client_start(pt_client_t *client,
                    pt_response_handler success_handler,
                    pt_response_handler failure_handler,
                    const char *name,
                    void *userdata);

pt_status_t pt_client_shutdown(pt_client_t *client);

#endif