2016-05-19 20:29:37 +00:00
|
|
|
/*-
|
|
|
|
* BSD LICENSE
|
|
|
|
*
|
|
|
|
* Copyright (c) Intel Corporation.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
*
|
|
|
|
* * Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in
|
|
|
|
* the documentation and/or other materials provided with the
|
|
|
|
* distribution.
|
|
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
|
|
* contributors may be used to endorse or promote products derived
|
|
|
|
* from this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* \file
|
|
|
|
* JSON-RPC 2.0 server implementation
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef SPDK_JSONRPC_H_
|
|
|
|
#define SPDK_JSONRPC_H_
|
|
|
|
|
|
|
|
#include "spdk/json.h"
|
|
|
|
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <inttypes.h>
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include <stddef.h>
|
|
|
|
|
|
|
|
#include <sys/ioctl.h>
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <sys/socket.h>
|
|
|
|
|
|
|
|
#define SPDK_JSONRPC_ERROR_PARSE_ERROR -32700
|
|
|
|
#define SPDK_JSONRPC_ERROR_INVALID_REQUEST -32600
|
|
|
|
#define SPDK_JSONRPC_ERROR_METHOD_NOT_FOUND -32601
|
|
|
|
#define SPDK_JSONRPC_ERROR_INVALID_PARAMS -32602
|
|
|
|
#define SPDK_JSONRPC_ERROR_INTERNAL_ERROR -32603
|
|
|
|
|
|
|
|
struct spdk_jsonrpc_server;
|
|
|
|
struct spdk_jsonrpc_server_conn;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* User callback to handle a single JSON-RPC request.
|
|
|
|
*
|
|
|
|
* The user should respond by calling one of spdk_jsonrpc_begin_result() or
|
|
|
|
* spdk_jsonrpc_send_error_response().
|
|
|
|
*/
|
|
|
|
typedef void (*spdk_jsonrpc_handle_request_fn)(
|
|
|
|
struct spdk_jsonrpc_server_conn *conn,
|
|
|
|
const struct spdk_json_val *method,
|
|
|
|
const struct spdk_json_val *params,
|
|
|
|
const struct spdk_json_val *id);
|
|
|
|
|
2016-12-13 22:58:42 +00:00
|
|
|
struct spdk_jsonrpc_server *spdk_jsonrpc_server_listen(int domain, int protocol,
|
|
|
|
struct sockaddr *listen_addr, socklen_t addrlen, spdk_jsonrpc_handle_request_fn handle_request);
|
2016-05-19 20:29:37 +00:00
|
|
|
|
|
|
|
int spdk_jsonrpc_server_poll(struct spdk_jsonrpc_server *server);
|
|
|
|
|
|
|
|
void spdk_jsonrpc_server_shutdown(struct spdk_jsonrpc_server *server);
|
|
|
|
|
|
|
|
struct spdk_json_write_ctx *spdk_jsonrpc_begin_result(struct spdk_jsonrpc_server_conn *conn,
|
|
|
|
const struct spdk_json_val *id);
|
|
|
|
void spdk_jsonrpc_end_result(struct spdk_jsonrpc_server_conn *conn, struct spdk_json_write_ctx *w);
|
|
|
|
|
|
|
|
void spdk_jsonrpc_send_error_response(struct spdk_jsonrpc_server_conn *conn,
|
|
|
|
const struct spdk_json_val *id, int error_code, const char *msg);
|
|
|
|
|
|
|
|
#endif
|