Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Wasm Sockets
Manage
Activity
Members
Labels
Code
Merge requests
1
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Microhacks
Wasm Sockets
Commits
c8d95877
Unverified
Commit
c8d95877
authored
4 years ago
by
scratchyone
Browse files
Options
Downloads
Patches
Plain Diff
Add docs to readme
parent
8e1ef4bd
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
Readme.md
+90
-0
90 additions, 0 deletions
Readme.md
with
90 additions
and
0 deletions
Readme.md
+
90
−
0
View file @
c8d95877
# wasm-sockets
# wasm-sockets
`wasm-sockets`
is a WASM only rust websocket library primarily designed for creating games.
`wasm-sockets`
is a WASM only rust websocket library primarily designed for creating games.
This crate offers 2 (wasm-only) websocket clients.
The first client offered is the
`EventClient`
. This client is event based and gives you the most control.
```
rs
use
console_error_panic_hook
;
use
console_log
;
use
log
::{
error
,
info
,
Level
};
use
std
::
panic
;
use
wasm_sockets
::{
self
,
WebSocketError
};
fn
main
()
->
Result
<
(),
WebSocketError
>
{
panic
::
set_hook
(
Box
::
new
(
console_error_panic_hook
::
hook
));
// console_log and log macros are used instead of println!
// so that messages can be seen in the browser console
console_log
::
init_with_level
(
Level
::
Trace
)
.expect
(
"Failed to enable logging"
);
info!
(
"Creating connection"
);
let
mut
client
=
wasm_sockets
::
EventClient
::
new
(
"wss://echo.websocket.org"
)
?
;
client
.set_on_error
(
Some
(
Box
::
new
(|
error
|
{
error!
(
"{:#?}"
,
error
);
})));
client
.set_on_connection
(
Some
(
Box
::
new
(|
client
:
&
wasm_sockets
::
EventClient
|
{
info!
(
"{:#?}"
,
client
.status
);
info!
(
"Sending message..."
);
client
.send_string
(
"Hello, World!"
)
.unwrap
();
client
.send_binary
(
vec!
[
20
])
.unwrap
();
})));
client
.set_on_close
(
Some
(
Box
::
new
(||
{
info!
(
"Connection closed"
);
})));
client
.set_on_message
(
Some
(
Box
::
new
(
|
client
:
&
wasm_sockets
::
EventClient
,
message
:
wasm_sockets
::
Message
|
{
info!
(
"New Message: {:#?}"
,
message
);
},
)));
info!
(
"Connection successfully created"
);
Ok
(())
}
```
The second client offered is the
`PollingClient`
. This client is ideal for games, because it is designed to be used with a loop.
This client is also much simpler than the
`EventClient`
. However, you can access the main
`EventClient`
that it is using
if you want access to lower level control.
```
rs
use
console_error_panic_hook
;
use
log
::{
info
,
Level
};
use
std
::
cell
::
RefCell
;
use
std
::
panic
;
use
std
::
rc
::
Rc
;
#[cfg(target_arch
=
"wasm32"
)]
use
wasm_bindgen
::
prelude
::
*
;
use
wasm_sockets
::{
self
,
ConnectionStatus
,
WebSocketError
};
fn
main
()
->
Result
<
(),
WebSocketError
>
{
panic
::
set_hook
(
Box
::
new
(
console_error_panic_hook
::
hook
));
// console_log and log macros are used instead of println!
// so that messages can be seen in the browser console
console_log
::
init_with_level
(
Level
::
Trace
)
.expect
(
"Failed to enable logging"
);
info!
(
"Creating connection"
);
// Client is wrapped in an Rc<RefCell<>> so it can be used within setInterval
// This isn't required when being used within a game engine
let
client
=
Rc
::
new
(
RefCell
::
new
(
wasm_sockets
::
PollingClient
::
new
(
"wss://echo.websocket.org"
,
)
?
));
let
f
=
Closure
::
wrap
(
Box
::
new
(
move
||
{
if
client
.borrow
()
.status
()
==
ConnectionStatus
::
Connected
{
info!
(
"Sending message"
);
client
.borrow
()
.send_string
(
"Hello, World!"
)
.unwrap
();
}
// receive() gives you all new websocket messages since receive() was last called
info!
(
"New messages: {:#?}"
,
client
.borrow_mut
()
.receive
());
})
as
Box
<
dyn
FnMut
()
>
);
// Start non-blocking game loop
setInterval
(
&
f
,
100
);
f
.forget
();
Ok
(())
}
// Bind setInterval to make a basic game loop
#[wasm_bindgen]
extern
"C"
{
fn
setInterval
(
closure
:
&
Closure
<
dyn
FnMut
()
>
,
time
:
u32
)
->
i32
;
}
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment