ExternalVendorCode/trick
1
0
Fork 0
mirror of https://github.com/nasa/trick.git synced 2025-06-19 23:53:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge Caleb Herpins port of Trick webserver from Mongoose to CivetWeb #730.

Browse Source
This commit is contained in:
Penn, John M 047828115
2021-08-18 13:15:10 -05:00
parent f6ce855683
commit 4c52ed2753
90 changed files with 2663 additions and 4020 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/documentation/web/Extending_the_WS-API.md
View File

@ -1,4 +1,4 @@
#Extending the WebSocket-API
## Extending the WebSocket-API
## When You Create a WebSocket Connection
@ -23,9 +23,9 @@ A ```WebSocketSession``` is a pure virtual base class meant to represent the sta
1. Synchronously marshall Trick simulation data for out-going messages
2. Send messages to the websocket client, and
3. Receive and process messages from the websocket client.
To implement a new websocket sub-protocol, one needs to derive a new class from this base class, and implement the required methods. ```WebSocketSession.hh``` can be found in ```${TRICK_HOME}/include/trick/```.
3. Receive and process messages from the websocket client.
To implement a new websocket sub-protocol, one needs to derive a new class from this base class, and implement the required methods. ```WebSocketSession.hh``` can be found in ```${TRICK_HOME}/include/trick/```.
### WebSocketSession.hh
```c
@ -37,13 +37,19 @@ PURPOSE: (Represent Websocket connection.)
#include <string>
#ifndef SWIG
#include "mongoose/mongoose.h"
#include "civet/CivetServer.h"
#endif
class WebSocketSession {
public:
WebSocketSession(struct mg_connection *nc):connection(nc){};
virtual ~WebSocketSession() {};
/**
When HTTP_Server::time_homogeneous is set, WebSocketSession::marshallData() is called from the main
sim thread in a "top_of_frame" job, so that all of the data can be staged at
the same sim-time, in other words it's time-homogeneous.
*/
virtual void marshallData()=0;
virtual void sendMessage()=0;
virtual int handleMessage(std::string)=0;
@ -109,6 +115,7 @@ Below is our implementation. Notice the function ```makeTimeSession``` at the bo
#include <time.h>
#include <iostream>
#include "TimeSession.hh"
#include <cstring>
// CONSTRUCTOR
TimeSession::TimeSession( struct mg_connection *nc ) : WebSocketSession(nc) {
@ -139,7 +146,7 @@ void TimeSession::sendMessage() {
int year = theTime->tm_year + 1900;
sprintf(message, "Time: %02d:%02d:%02d Date: %02d/%02d/%d\n", hours, minutes, seconds, month, day, year);
mg_send_websocket_frame(connection, WEBSOCKET_OP_TEXT, message, strlen(message));
mg_websocket_write(connection, MG_WEBSOCKET_OPCODE_TEXT, message, strlen(message));
}
int TimeSession::handleMessage(std::string client_msg) {
@ -180,14 +187,15 @@ LIBRARY DEPENDENCIES:
(
(cannon/gravity/src/cannon_init.c)
(cannon/gravity/src/cannon_numeric.c)
(httpMethods/TimeSession.cpp) // <--(1)
(httpMethods/handle_HTTP_GET_hello.c)
(httpMethods/TimeSession.cpp)
)
*************************************************************/
#include "sim_objects/default_trick_sys.sm"
#include "sim_objects/WebServer.sm" // <--(2)
#include "sim_objects/CivetServer.sm"
##include "cannon/gravity/include/cannon_numeric.h"
##include "httpMethods/TimeSession.hh" // <--(3)
##include "httpMethods/TimeSession.hh"
class CannonSimObject : public Trick::SimObject {
@ -204,11 +212,12 @@ class CannonSimObject : public Trick::SimObject {
} ;
CannonSimObject dyn ;
IntegLoop dyn_integloop (0.10) dyn;
IntegLoop dyn_integloop (0.01) dyn;
void create_connections() {
dyn_integloop.getIntegrator(Runge_Kutta_4, 5);
web.server.installWebSocketSessionMaker("Time", &makeTimeSession); // <--(4)
web.server.installHTTPGEThandler( "hello", &handle_HTTP_GET_hello );
web.server.installWebSocketSessionMaker( "Time", &makeTimeSession );
}
```