1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef NET_TEST_EMBEDDED_TEST_SERVER_INSTALL_DEFAULT_WEBSOCKET_HANDLERS_H_
#define NET_TEST_EMBEDDED_TEST_SERVER_INSTALL_DEFAULT_WEBSOCKET_HANDLERS_H_
#include <string_view>
#include "net/test/embedded_test_server/embedded_test_server.h"
#include "url/gurl.h"
namespace net::test_server {
// Installs default WebSocket handlers, such as the echo handler, on the given
// EmbeddedTestServer instance. Optionally, it can also configure the server to
// serve WebSocket test data files from the `net/data/websocket` directory.
//
// Parameters:
// - `server`: The EmbeddedTestServer instance to configure.
// - `serve_websocket_test_data`: If true, serves test data files from
// `net/data/websocket`. Default is false.
//
// Note:
// - The `ServeFilesFromDirectory` function registers a file handler as part of
// the server's request handlers. The first handler to provide a valid
// response will "win," and subsequent handlers will not override the
// response.
// - To ensure consistent behavior, it is recommended that only one file handler
// (e.g., via `ServeFilesFromDirectory`) is installed per server instance.
// - If multiple calls to `ServeFilesFromDirectory` are necessary, ensure they
// serve distinct sets of files or are added intentionally to the
// request-handling chain.
void InstallDefaultWebSocketHandlers(EmbeddedTestServer* server,
bool serve_websocket_test_data = false);
// Converts a given HTTP or HTTPS URL to a corresponding WebSocket (ws) or
// Secure WebSocket (wss) URL, depending on the server's SSL configuration.
GURL ToWebSocketUrl(const GURL& url);
// Generates a WebSocket URL using the specified EmbeddedTestServer and a
// relative URL path, which must start with '/'. Returns a WebSocket URL
// prefixed with ws:// or wss:// based on the server's configuration.
GURL GetWebSocketURL(const EmbeddedTestServer& server,
std::string_view relative_url);
// Similar to the above GetWebSocketURL function but allows specifying a
// custom hostname in place of the default '127.0.0.1'. The hostname should
// resolve to 127.0.0.1 for local testing purposes.
GURL GetWebSocketURL(const EmbeddedTestServer& server,
std::string_view hostname,
std::string_view relative_url);
} // namespace net::test_server
#endif // NET_TEST_EMBEDDED_TEST_SERVER_INSTALL_DEFAULT_WEBSOCKET_HANDLERS_H_
|
