VILLASnode/include/villas/nodes/websocket.h

/** Node type: WebSockets
 *
 * This file implements the websocket type for nodes.
 * It's based on the libwebsockets library.
 *
 * @file
 * @author Steffen Vogel <stvogel@eonerc.rwth-aachen.de>
 * @copyright 2014-2016, Institute for Automation of Complex Power Systems, EONERC
 *   This file is part of VILLASnode. All Rights Reserved. Proprietary and confidential.
 *   Unauthorized copying of this file, via any medium is strictly prohibited. 
 */
/**
 * @addtogroup websockets WebSockets node type
 * @ingroup node
 * @{
 *********************************************************************************/


#ifndef _WEBSOCKET_H_
#define _WEBSOCKET_H_

#include "node.h"
#include "pool.h"
#include "queue.h"

/* Forward declaration */
struct lws;

/** Internal data per websocket node */
struct websocket {
	struct list connections;		/**< List of active libwebsocket connections in server mode (struct websocket_connection) */

	struct list destinations;		/**< List of struct lws_client_connect_info to connect to in client mode. */
	
	struct pool pool;
	
	struct queue queue;			/**< For samples which are received from WebSockets a */
	
	int id;					/**< The index of this node */
};

struct websocket_connection {
	enum {
		WEBSOCKET_ESTABLISHED,
		WEBSOCKET_ACTIVE,
		WEBSOCKET_SHUTDOWN,
		WEBSOCKET_CLOSED
	} state;
	
	struct node *node;
	struct path *path;
	
	struct queue queue;			/**< For samples which are sent to the WebSocket */
	
	struct lws *wsi;
	
	struct {
		char name[64];
		char ip[64];
	} peer;
};

/** @see node_vtable::init */
int websocket_init(int argc, char * argv[], config_setting_t *cfg);

/** @see node_vtable::deinit */
int websocket_deinit();

/** @see node_vtable::open */
int websocket_open(struct node *n);

/** @see node_vtable::close */
int websocket_close(struct node *n);

/** @see node_vtable::close */
int websocket_destroy(struct node *n);

/** @see node_vtable::read */
int websocket_read(struct node *n, struct sample *smps[], unsigned cnt);

/** @see node_vtable::write */
int websocket_write(struct node *n, struct sample *smps[], unsigned cnt);

#endif /** _WEBSOCKET_H_ @} */