Browse Source

Added comment for disableTlsVerification

Paul-Louis Ageneau 5 years ago
parent
commit
a2d1b7eff0
2 changed files with 3 additions and 4 deletions
  1. 2 3
      include/rtc/rtc.h
  2. 1 1
      include/rtc/websocket.hpp

+ 2 - 3
include/rtc/rtc.h

@@ -122,12 +122,11 @@ RTC_EXPORT int rtcGetDataChannelLabel(int dc, char *buffer, int size);
 // WebSocket
 #if RTC_ENABLE_WEBSOCKET
 typedef struct {
-	bool disableTlsVerification;
+	bool disableTlsVerification; // if true, don't verify the TLS certificate
 } rtcWsConfiguration;
 
 RTC_EXPORT int rtcCreateWebSocket(const char *url); // returns ws id
-RTC_EXPORT int rtcCreateWebSocketEx(const char *url,
-                                    const rtcWsConfiguration *config); // returns ws id
+RTC_EXPORT int rtcCreateWebSocketEx(const char *url, const rtcWsConfiguration *config);
 RTC_EXPORT int rtcDeleteWebsocket(int ws);
 #endif
 

+ 1 - 1
include/rtc/websocket.hpp

@@ -48,7 +48,7 @@ public:
 	};
 
 	struct Configuration {
-		bool disableTlsVerification = false;
+		bool disableTlsVerification = false; // if true, don't verify the TLS certificate
 	};
 
 	WebSocket(std::optional<Configuration> config = nullopt);