HTTP Pull delivery

HTTP Pull is a communication model where a client (e.g., a web browser or app) initiates a request to a server to retrieve information. The server responds by sending the requested data. This approach is called "pull" because the client actively requests (or pulls) the data from the server, as opposed to the server pushing updates to the client.

For instance, with OrbitSailor, a streaming service, clients can use HTTP Pull to receive its streaming data. The client sends an HTTP request to OrbitSailor's servers, and the server responds with the streaming content in real-time or as requested. This makes OrbitSailor's streaming easily accessible to clients using standard HTTP protocols.

Setting up the delivery method

To setup the HTTP Pull delivery method follow the steps:

1. Login to the OrbitSailor Configuration Dashboard with admin rights
2. Go to the Service Configuration
3. Navigate to DELIVERY CONFIGURATION tab
4. Click on ADD DELIVERY CONFIGURATION
5. Enter a new name in the Endpoint Name field
6. Select HTTP Pull from the Type drop-down list
7. Optionally you can configure your custom message (if applicable) by enabling Customize Message Format and you can also customize data segmend size by enabling and configuring the Customize Segment Size
8. Click on GENERATE URL to create the delivery URL
9. Set expiration date in the pop-up window, note that once the date expires, a new URL must be generated
10. Click on GENERATE to finalize the URL
11. Copy the URL: use the Copy button to quickly copy the generated URL or manually select and copy the entire URL path
12. Save the configuration by clicking on SAVE button

The HTTP Pull delivery method is now set up and ready for use.

WARNING

If the connection to the server is interrupted, HTTP Pull data delivery will also be disrupted. Ensure that your HTTP Pull client is configured to automatically resume the connection to avoid data delivery interruptions.

Testing the service delivery

The simplest and most reliable way to test the HTTP Pull service is by using the curl tool. This method allows advanced users to quickly verify the service's configuration and response.

To test on Windows, follow these steps:

1. Open Windows PowerShell
2. Enter the following command

curl.exe _the_generated_code

Replace _the_generated_code with the actual code provided by the OrbitSailor.

If the service is correctly configured, you should receive the data immediately. The image below demonstrates how the RawAISService output appears when successfully retrieved using this method: