update doc for next release

[ust.git] / libustcomm / ustcomm.h

/* Copyright (C) 2009  Pierre-Marc Fournier
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef USTCOMM_H
#define USTCOMM_H

#include <sys/types.h>
#include <sys/un.h>
#include <urcu/list.h>

#include <ust/kcompat/kcompat.h>
#include "multipoll.h"

#define SOCK_DIR "/tmp/ust-app-socks"
#define UST_SIGNAL SIGIO

struct ustcomm_connection {
	struct list_head list;
	int fd;
	/* Data that has not yet been consumed: */
	char *recv_buf;
	int recv_buf_size;
	int recv_buf_alloc;
};

/* ustcomm_server must be shallow-copyable */
struct ustcomm_server {
	/* the "server" socket for serving the external requests */
	int listen_fd;
	char *socketpath;

	struct list_head connections;
};

struct ustcomm_ustd {
	struct ustcomm_server server;
};

struct ustcomm_app {
	struct ustcomm_server server;
};

/* ustcomm_source must be shallow-copyable */
struct ustcomm_source {
	int fd;
	void *priv;
};

struct ustcomm_multipoll_conn_info {
	struct ustcomm_connection *conn;
	int (*cb)(char *msg, struct ustcomm_source *src);
};

//int send_message_pid(pid_t pid, const char *msg, char **reply);
extern int ustcomm_request_consumer(pid_t pid, const char *channel);

extern int ustcomm_ustd_recv_message(struct ustcomm_ustd *ustd, char **msg, struct ustcomm_source *src, int timeout);
extern int ustcomm_app_recv_message(struct ustcomm_app *app, char **msg, struct ustcomm_source *src, int timeout);

extern int ustcomm_init_app(pid_t pid, struct ustcomm_app *handle);
extern void ustcomm_fini_app(struct ustcomm_app *handle, int keep_socket_file);
extern void ustcomm_fini_ustd(struct ustcomm_ustd *handle);

extern int ustcomm_init_ustd(struct ustcomm_ustd *handle, const char *sock_path);

extern int ustcomm_connect_app(pid_t pid, struct ustcomm_connection *conn);
extern int ustcomm_close_app(struct ustcomm_connection *conn);
extern int ustcomm_connect_path(const char *path, struct ustcomm_connection *conn, pid_t signalpid);
extern int ustcomm_send_request(struct ustcomm_connection *conn, const char *req, char **reply);
extern int ustcomm_send_reply(struct ustcomm_server *server, char *msg, struct ustcomm_source *src);
extern int ustcomm_disconnect(struct ustcomm_connection *conn);
extern int ustcomm_close_all_connections(struct ustcomm_server *server);
extern void ustcomm_mp_add_app_clients(struct mpentries *ent, struct ustcomm_app *app, int (*cb)(char *recvbuf, struct ustcomm_source *src));

extern int nth_token_is(const char *str, const char *token, int tok_no);

extern char *nth_token(const char *str, int tok_no);

extern int pid_is_online(pid_t);

#endif /* USTCOMM_H */