Android™
Android™
Firebase Receive Server-Sent Events (text/event-stream)
See more Firebase Examples
Demonstrates how to start receiving server-sent events and update your JSON database with each event.Chilkat Android™ Downloads
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
boolean success = false;
// Demonstrates how to begin receiving server-sent events, and to update
// your JSON database for each event.
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// This example assumes a JWT authentication token, if required, has been previously obtained.
// See Get Firebase Access Token from JSON Service Account Private Key for sample code.
// Load the previously obtained Firebase access token into a string.
CkFileAccess fac = new CkFileAccess();
String accessToken = fac.readEntireTextFile("qa_data/tokens/firebaseToken.txt","utf-8");
if (fac.get_LastMethodSuccess() == false) {
Log.i(TAG, fac.lastErrorText());
return;
}
CkRest rest = new CkRest();
// Make the initial connection (without sending a request yet).
// Once connected, any number of requests may be sent. It is not necessary to explicitly
// call Connect before each request.
success = rest.Connect("chilkat.firebaseio.com",443,true,true);
if (success == false) {
Log.i(TAG, rest.lastErrorText());
return;
}
CkAuthGoogle authGoogle = new CkAuthGoogle();
authGoogle.put_AccessToken(accessToken);
rest.SetAuthGoogle(authGoogle);
rest.AddHeader("Accept","text/event-stream");
rest.AddHeader("Cache-Control","no-cache");
String responseBody = rest.fullRequestNoBody("GET","/.json");
// A 307 redirect response is expected.
if (rest.get_ResponseStatusCode() != 307) {
Log.i(TAG, "Unexpected response code: " + String.valueOf(rest.get_ResponseStatusCode()));
Log.i(TAG, responseBody);
Log.i(TAG, "Failed.");
return;
}
// Get the redirect URL
String urlStr = rest.lastRedirectUrl();
CkUrl url = new CkUrl();
url.ParseUrl(urlStr);
Log.i(TAG, "redirect URL domain: " + url.host());
Log.i(TAG, "redirect URL path: " + url.path());
Log.i(TAG, "redirect URL query params: " + url.query());
Log.i(TAG, "redirect URL path with query params: " + url.pathWithQueryParams());
// Our text/event-stream will be obtained from the redirect URL...
CkRest rest2 = new CkRest();
success = rest2.Connect(url.host(),443,true,true);
if (success != true) {
Log.i(TAG, rest2.lastErrorText());
return;
}
rest2.AddHeader("Accept","text/event-stream");
rest2.AddHeader("Cache-Control","no-cache");
// Add the redirect query params to the request
rest2.AddQueryParams(url.query());
// In our case, we don't actually need the auth query param,
// so remove it.
rest2.RemoveQueryParam("auth");
// Send the request. (We are only sending the request here.
// We are not yet getting the response because the response
// will be a text/event-stream.)
success = rest2.SendReqNoBody("GET",url.path());
if (success != true) {
Log.i(TAG, rest2.lastErrorText());
return;
}
// Read the response header.
// We want to first get the response header to see if it's a successful
// response status code. If not, then the response will not be a text/event-stream
// and we should read the response body normally.
int responseStatusCode = rest2.ReadResponseHeader();
if (responseStatusCode < 0) {
Log.i(TAG, rest2.lastErrorText());
return;
}
// If successful, a 200 response code is expected.
// If the reponse code is not 200, then read the response body and fail..
if (responseStatusCode != 200) {
Log.i(TAG, "Response Code: " + String.valueOf(responseStatusCode));
Log.i(TAG, "Response Status Text: " + rest2.responseStatusText());
Log.i(TAG, "Response Header: " + rest2.responseHeader());
responseBody = rest2.readRespBodyString();
if (rest2.get_LastMethodSuccess() == true) {
Log.i(TAG, "Error Response Body: " + responseBody);
}
Log.i(TAG, "Failed.");
return;
}
// For this example, our JSON database will be empty at the beginning.
// The incoming events (put and patch) will be applied to this database.
CkJsonObject jsonDb = new CkJsonObject();
// Make sure to set the JSON path delimiter to "/". The default is "." and this
// is not compatible with Firebase paths.
jsonDb.put_DelimiterChar("/");
// At this point, we've received the response header. Now it's time to begin
// receiving the event stream. We'll start a background thread to read the
// stream. (Our main application (foreground) thread can cancel it at any time.)
// While receiving in the background thread, our foreground thread can read the stream
// as it desires..
CkStream eventStream = new CkStream();
// This sse object will be used as a helper to parse the server-sent event stream.
CkServerSentEvent sse = new CkServerSentEvent();
CkTask task = rest2.ReadRespBodyStreamAsync(eventStream,true);
task.Run();
// For this example, we'll just read a few events, and then cancel the
// async task.
int count = 0;
while ((count < 3) and (task.get_Finished() == false)) {
// Get the next event, which is a series of text lines ending with
// a blank line.
// Note: This method blocks the calling thread until a message arrives.
// a program might instead periodically check the availability of
// data via the stream's DataAvailable property, and then do the read.
// An alternative to writing a while loop to read the event stream
// would be to setup some sort of timer event in your program (using whatever timer functionality
// is provided in a programming language/environment), to periodically check the eventStream's
// DataAvailable property and consume the incoming event.
String eventStr = eventStream.readUntilMatch("\r\n\r\n");
if (eventStream.get_LastMethodSuccess() != true) {
Log.i(TAG, eventStream.lastErrorText());
// Force the loop to exit by setting the count to a high number.
count = 99999;
}
else {
Log.i(TAG, "Event: [" + eventStr + "]");
// We have an event. Let's update our local copy of the JSON database.
success = sse.LoadEvent(eventStr);
if (success != true) {
Log.i(TAG, "Failed to load sse event: " + eventStr);
}
else {
// Now we can easily access the event name and data, and apply it to our JSON database:
success = jsonDb.FirebaseApplyEvent(sse.eventName(),sse.data());
if (success != true) {
Log.i(TAG, "Failed to apply event: " + sse.eventName() + ": " + sse.data());
}
else {
Log.i(TAG, "Successfully applied event: " + sse.eventName() + ": " + sse.data());
}
}
}
count = count + 1;
}
// Make sure the background task is cancelled if still running.
task.Cancel();
// Examine the JSON database after applying events..
jsonDb.put_EmitCompact(false);
Log.i(TAG, "----");
Log.i(TAG, jsonDb.emit());
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}