Logging UDPs when Timeline is running on expServer

[k1o0]

UDPs sent events may be logged in Timeline by your services:

In prepareExp, if your srv.Service object has a Timeline property, it is assigned a handle to srv.expServer's hw.Timeline instance.

Rigbox/+srv/prepareExp.m

Lines 17 to 31 in cd888f0

	%configure actions to start and stop services
	if isfield(params, 'services') && ~isempty(params.services)
	services = srv.findService(params.services); % Uses basicServices
	% services = srv.loadService(params.services); % Loads BasicUDPService objects
	for i = 1:length(services)
	if isprop(services{i},'Timeline')
	services{i}.Timeline = rig.timeline;
	end
	end
	startServices = exp.StartServices(services);
	stopServices = exp.StopServices(services);
	experiment.addEventHandler(...
	exp.EventHandler('experimentInit', startServices),...
	exp.EventHandler('experimentCleanup', stopServices));
	end

When the services are started (a callback of the experimentInit event) or stopped (a callback of the experimentCleanup event), the start and stop methods of your service object may log the event with using Timeline's record method.

What service subclasses are people using (e.g. srv.PrimitiveUDPService)? It's here that you need to add the logic for recording the UDP events. See the code for srv.RemoteMPEPService:

Rigbox/cortexlab/+srv/RemoteMPEPService.m

Lines 222 to 234 in cd888f0

	function receiveUDP(obj, src, evt)
	obj.LastReceivedMessage = strtrim(fscanf(obj.Socket));
	% Let everyone know a message was recieved
	notify(obj, 'MessageReceived')
	hosts = arrayfun(@(s)s.Tag, obj.Sockets);
	if ~isempty(obj.Timeline)&&obj.Timeline.IsRunning
	t = obj.Timeline.time; % Note the time
	% record the UDP event in Timeline
	obj.Timeline.record([hosts 'UDP'], msg, t);
	end
	% Pass message to callback function for precessing
	feval(obj.Callbacks{strcmp(hosts, src.Tag)}, src, evt);
	end

Note that the block file contains the timestamps for the experiment events, which will be in Timeline time if it's running for that experiment. These timestamps will tell you when the tart and stop methods were called, which should be just before the UDPs are sent.