Skip to content

Close Lighthouse properly in examples #17

Description

@fwcd

We should use the recently added Lighthouse::close method1 in the examples to avoid closing the WebSocket without sending the close handshake (while not critical, it seems to be good practice to do so):

/// Closes the WebSocket connection gracefully with a close message. While
/// the server will usually also handle abruptly closed connections
/// properly, it is recommended to always close the [``Lighthouse``].
pub async fn close(&mut self) -> Result<()> {
Ok(self.ws_sink.close().await?)
}

Depending on the type of application, there seem to be two reasonable approaches here:

  • For one-shot scripts (e.g. examples/black.rs), simply call (and await) .close() at the end of the script
  • For REPLs (e.g. limo) we could likely do the same, but would make sure that ctrl-d properly goes down this code path
  • For continuously running applications (e.g. games), set up a signal handler (e.g. await Tokio's ctrl-c) and then call .close()

Footnotes

  1. Unfortunately we cannot just put this method into a Drop implementation due to being async and error-throwing. We could look into spawning a task in the drop handler, but that would no longer let us await the close, which could lead to subtle/hard-to-debug race conditions.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions