> For the complete documentation index, see [llms.txt](https://mpostol.gitbook.io/pip/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mpostol.gitbook.io/pip/distributed-programming/client-server-communication/websocketapi.md).

# WebSocket API

The example has been derived from the project [M. Postol; NBlockchain; NBlockchain/P2PPrototocol/NodeJSAPI/](https://github.com/mpostol/NBlockchain/tree/master/P2PPrototocol/NodeJSAPI)

## Introduction

The WebSocket Protocol enables two-way communication between a client running untrusted code in a controlled environment to a remote host that has opted-in to communications from that code. The security model used for this is the origin-based security model commonly used by web browsers. The protocol consists of an opening handshake followed by basic message framing, layered over TCP. The goal of this technology is to provide a mechanism for browser-based applications that need two-way communication with servers that does not rely on opening multiple HTTP connections (e.g., using XMLHttpRequest or \<iframe>s and long polling).

## See also

* [The WebSocket Protocol; Request for Comments: 6455; 2011](https://tools.ietf.org/html/rfc6455)
* [The WebSocket API; W3C Candidate Recommendation 20 September 2012](https://www.w3.org/TR/websockets/)
* [M. Postol; NBlockchain; NBlockchain/P2PPrototocol/NodeJSAPI/; Rel.1.0](https://github.com/mpostol/NBlockchain/tree/master/P2PPrototocol/NodeJSAPI)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://mpostol.gitbook.io/pip/distributed-programming/client-server-communication/websocketapi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.