sh2lib.h

Go to the documentation of this file.

// Copyright 2017 Espressif Systems (Shanghai) PTE LTD
//
// 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 __ESP_EXAMPLE_SH2_LIB_H_
#define __ESP_EXAMPLE_SH2_LIB_H_

#include "esp_tls.h"
#include <nghttp2/nghttp2.h>

/*
 * This is a thin API wrapper over nghttp2 that offers simplified APIs for usage
 * in the application. The intention of this wrapper is to act as a stepping
 * stone to quickly get started with using the HTTP/2 client. Since the focus is
 * on simplicity, not all the features of HTTP/2 are supported through this
 * wrapper. Once you are fairly comfortable with nghttp2, feel free to directly
 * use nghttp2 APIs or make changes to sh2lib.c for realising your objectives.
 *
 * TODO:
 * - Allowing to query response code, content-type etc in the receive callback
 * - A simple function for per-stream header callback
 */
struct sh2lib_handle {
    nghttp2_session *http2_sess;   
    char            *hostname;     
    struct esp_tls  *http2_tls;    
    void            *userdata;
};

#define DATA_RECV_RST_STREAM      1

#define DATA_RECV_FRAME_COMPLETE  2

typedef int (*sh2lib_frame_data_header_cb_t)(struct sh2lib_handle *handle, const char *name, size_t namelen, const char *value, size_t valuelen, int flags);
typedef int (*sh2lib_frame_data_recv_cb_t)(struct sh2lib_handle *handle, const char *data, size_t len, int flags);

typedef int (*sh2lib_putpost_data_cb_t)(struct sh2lib_handle *handle, char *data, size_t len, uint32_t *data_flags);

typedef struct {
  sh2lib_putpost_data_cb_t send_cb;
  sh2lib_frame_data_header_cb_t header_recv_cb;
  sh2lib_frame_data_recv_cb_t data_recv_cb;
} sh2lib_callbacks;

int sh2lib_connect(struct sh2lib_handle *hd, const char *uri, mbedtls_x509_crt* cacerts);

void sh2lib_free(struct sh2lib_handle *hd);

int sh2lib_do_get(struct sh2lib_handle *hd, const char *path, sh2lib_callbacks* callbacks);

int sh2lib_do_post(struct sh2lib_handle *hd, const char *path,
                   sh2lib_callbacks* callbacks);

int sh2lib_do_put(struct sh2lib_handle *hd, const char *path,
                  sh2lib_callbacks* callbacks);

int sh2lib_execute(struct sh2lib_handle *hd);

#define SH2LIB_MAKE_NV(NAME, VALUE, FLAGS)                                    \
  {                                                                           \
    (uint8_t *)NAME, (uint8_t *)VALUE, strlen(NAME), strlen(VALUE), FLAGS     \
  }

int sh2lib_do_get_with_nv(struct sh2lib_handle *hd, const nghttp2_nv *nva, size_t nvlen, sh2lib_callbacks* callbacks);

int sh2lib_do_putpost_with_nv(struct sh2lib_handle *hd, const nghttp2_nv *nva, size_t nvlen,
                              sh2lib_callbacks* callbacks);

#endif /* ! __ESP_EXAMPLE_SH2_LIB_H_ */