Skip to main content

Sending event: Emitter

Events are sent using an Emitter class. You can initialize a class with a collector endpoint URL and optionally choose the HTTP POST method instead of GET.

Emitter(uri:string, httpMethod:String)

For example:

var e1:Emitter = new Emitter("");
var e2:Emitter = new Emitter("", URLRequestMethod.POST);
Argument NameDescriptionRequired?
uriThe collector endpoint URI events will be sent toYes
httpMethodThe HTTP method to use when sending eventsNo

Using a buffer

A buffer is used to group events together in bulk before sending them. This is useful to reduce network usage. By default, the AS3 Emitter does not buffer but instead sends events instantly as soon as they are created. You can use a buffer instead by calling setBufferOption with the number of events to batch together in the buffer:

var e1:Emitter = new Emitter("");

There are two predefined constants but you can use any integer value:

BufferOption.DEFAULT1. Events are sent as soon as they are created
BufferOption.BATCH10. Sends events in a group when 10 events are created

Choosing the HTTP method

Snowplow supports receiving events via GET and POST requests. In a GET request, each event is sent in an individual request. With POST requests, events are bundled together in one request.

You can set the HTTP method in the Emitter constructor:

var e1:Emitter = new Emitter("", URLRequestMethod.POST);

The default method is GET.

Actionscript provides standard constants for the two options in the URLRequestMethod class:

URLRequestMethod.GET URLRequestMethod.POST

Method of sending HTTP requests

An AS3 Emitter sends requests asynchronously. Flash does not support synchronous requests.

Emitter callback

The AS3 Emitter dispatches events when it succeeds or fails to flush the buffer.

You can register event listeners for these events if you need to handle the success or failure case. Here is a sample bit of code to show how it could work:

var emitter:Emitter = new Emitter(testURL);
emitter.addEventListener(EmitterEvent.SUCCESS, function(bufferLength:int) {
trace("Buffer length for POST/GET:" + bufferLength);
emitter.addEventListener(EmitterEvent.FAILURE, function (successCount:int, failedEvents:Array, errorString:String) {
trace("Failure, successCount: " + successCount + "\nfailedEvents:\n" + failedEvents.toString() + "\nerror:\n" + errorString:String);

In the example, we can see in-line handling of the both cases. If events are all successfully sent, the success callback method receives the number of successful events sent. If there were any failures, the failure callback method receives the number of successful events sent (if any) and a Array of events that failed to be sent (i.e. the HTTP state code did not return 200). In addition, in the case of failure, an additional parameter is provided with the text of the network or security error that caused the failure.

Was this page helpful?