Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.04 KB

Protocol.md

File metadata and controls

50 lines (32 loc) · 2.04 KB
Raw

Protocol

The client library communicates with Meteor servers over the Distributed Data Protocol (DDP).

Debugging

Initialization

  1. Run this online tool that you will use to connect to your local Meteor instance

  2. Enter the WebSocket URL (and leave the protocol field empty):

    ws://localhost:3000/websocket

  3. Initialize the DDP connection (using an older protocol that does not require ping/pong events):

    {"msg":"connect","version":"pre1","support":["pre1"]}

Exemplary commands

  • Create a new record (document) users/jane on the server:

    {"msg":"method","method":"/database/update","params":[{"_id":"/users/jane"}, {"_id":"/users/jane","_priority":null,"_value":"Jane Doe"},{"upsert":true}],"id":"client-event-1"}

  • Subscribe to a single location or path (document) from the server:

    {"msg":"sub","id":"subscription-1","name":"node","params":["/users", true]}

  • Delete a the document at a certain (child of root collection) by ID:

    {"msg":"method","method":"/database/remove","params":[{"_id":"/users/john"}],"id":"client-event-2"}

  • Call some arbitrary method defined on the server:

    {"msg":"method","method":"myMethodName","params":[],"id":"client-event-3"}

Verifying against a Meteor client app written in JavaScript

  1. In your web browser, open a website built with Meteor, such as the official Meteor website itself.
  2. Open the browser's console
  3. Type JSON.stringify(Object.keys(Meteor.default_connection._methodHandlers).sort()); to view all methods defined on the client
  4. Type JSON.stringify(Object.keys(Meteor.default_connection._mongo_livedata_collections).sort()); to view all collections accessible to the client
  5. Type JSON.stringify(new Meteor.Collection("myCollection")._collection._docs._map); to look up the contents of any collection called myCollection as seen by the client