Writing and Running Custom Event Handler Functions

Write Custom Event Handler Function

You can process events related to any data updates by writing a custom event handler function for use with Datafeed Toolbox™. For example, you can monitor prices before creating an order or plot interval data in a graph. Follow these basic steps to write a custom event handler.

1. Choose the events you want to process, monitor, or evaluate.

2. Decide how the custom event handler processes these events.

3. Determine the input and output arguments for the custom event handler function.

4. Write the code for the custom event handler function.

For details, see Create Functions in Files. For a code example of a Bloomberg^® event handler function, enter edit v3stockticker.m at the command line.

Run Custom Event Handler Function

You can run the custom event handler function by passing the function name as an input argument into an existing function. Specify the custom event handler function name either as a character vector, string, or function handle. For details about function handles, see Create Function Handle.

For example, suppose you want to retrieve real-time data from Bloomberg using realtime with the custom event handler function named eventhandler. You can use either of the following syntaxes to run eventhandler. This code assumes a Bloomberg connection c, security list s, Bloomberg data fields f, Bloomberg subscription subs, and MATLAB^® timer t.

Use a character vector or string.

[subs,t] = realtime(c,s,f,'eventhandler');

Alternatively, use a function handle.

[subs,t] = realtime(c,s,f,@eventhandler);

For Bloomberg EMSX interfaces, you can run the custom event handler function by using timer. Specify the custom event handler function name as a function handle and pass this function handle as an input argument to timer. For details about function handles, see Create Function Handle. For example, suppose you want to create an order using createOrderAndRoute with the custom event handler function named eventhandler. This code assumes a Bloomberg EMSX connection c, Bloomberg EMSX order order, and timer object t.

1. Run timer to execute eventhandler. The name-value argument TimerFcn specifies the event handler function. The name-value argument Period specifies a 1-second delay between executions of the event handler function. When the name-value argument ExecutionMode is set to fixedRate, the event handler function executes immediately after it is added to the MATLAB execution queue.

   t = timer('TimerFcn',{@c.eventhandler},'Period',1, ...
             'ExecutionMode','fixedRate');
   

2. Start the timer to initiate and execute eventhandler immediately.

   start(t)
   

3. Run createOrderAndRoute using the custom event handler by setting useDefaultEventHandler to false.

   createOrderAndRoute(c,order,'useDefaultEventHandler',false)
   

4. Stop the timer to stop data updates.

   stop(t)
   

   If you want to resume data updates, run start.

5. Delete the timer once you are done with processing data updates for the Bloomberg EMSX connection.

   delete(t)

Workflow for Custom Event Handler Function

This workflow summarizes the basic steps to work with a custom event handler function for any of the data service providers, except Bloomberg EMSX.

1. Write a custom event handler function and save it to a file.

2. Create a connection to the data service provider.

3. Subscribe to a specific security using an existing function or API syntax.

4. Run an existing function to receive data updates and use the custom event handler function as an input argument.

5. Stop data updates by using stop or by closing the connection to the data service provider.

6. Close the connection to the data service provider if the connection is still open.

For Bloomberg EMSX interfaces, follow this workflow.

1. Write a custom event handler function and save it to a file.

2. Create a connection using emsx.

3. Subscribe to Bloomberg EMSX fields using orders and routes. You can also write custom event handler functions to process subscription events.

4. Run the custom event handler function using timer. Use a function handle to specify the custom event handler function name to run timer.

5. Start the timer to execute the custom event handler function immediately using start.

6. Stop data updates using stop.

7. Unsubscribe from Bloomberg EMSX fields by using the API syntax.

8. Delete the timer using delete.

9. Close the connection using close.