UWS WebSockets Library: Comprehensive API Reference

_address_string(websocket_address, ip_address_string, ip_address_string_length, port_string, port_string_length); return status; }

/**

Reads data from a websocket connection
@param websocket_connection The websocket connection
@param data The buffer to write the data to
@param data_length The maximum length of the data to read
@param read_length A pointer to a size_t that will receive the
actual amount of data read
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_connection_read( uws_websocket_connection websocket_connection, char* data, size_t data_length, size_t* read_length ) { return websocket_connection->read( websocket_connection, data, data_length, read_length ); }

/**

Writes data to a websocket connection
@param websocket_connection The websocket connection
@param data The data to write
@param data_length The length of the data to write
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_connection_write( uws_websocket_connection websocket_connection, const char* data, size_t data_length ) { return websocket_connection->write( websocket_connection, data, data_length ); }

/**

Writes text to a websocket connection
@param websocket_connection The websocket connection
@param text The text to write
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_connection_write_text( uws_websocket_connection websocket_connection, const char* text ) { return websocket_connection->write_text( websocket_connection, text ); }

/**

Closes a websocket connection
@param websocket_connection The websocket connection
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_connection_close( uws_websocket_connection websocket_connection ) { return websocket_connection->close(websocket_connection); }

/**

Frees a websocket connection
@param websocket_connection The websocket connection / UWS_EXTERN void uws_websocket_connection_free( uws_websocket_connection websocket_connection ) { if (websocket_connection->free) { websocket_connection->free(websocket_connection); } }

/**

Creates a websocket server
@param web_server The webserver
@param websocket_server A pointer to the websocket server object
that will be created
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_server_create( uws_web_server web_server, uws_websocket_server** websocket_server ) { *websocket_server = web_server->create_websocket_server(web_server); if (!(*websocket_server)) { return UWS_INTERNAL_ERROR; } return UWS_OK; }

/**

Starts a websocket server
@param websocket_server The websocket server
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_server_start( uws_websocket_server websocket_server ) { return websocket_server->start(websocket_server); }

/**

Stops a websocket server
@param websocket_server The websocket server
@return UWS_OK on success / UWS_EXTERN uws_status uws_websocket_server_stop( uws_websocket_server websocket_server ) { return websocket_server->stop(websocket_server); }

/**

Frees a websocket server
@param websocket_server The websocket server / UWS_EXTERN void uws_websocket_server_free( uws_websocket_server websocket_server ) { if (websocket_server->free) { websocket_server->free(websocket_server); } }