et_viewer(3erl) [linux man page]

et_viewer(3erl) 					     Erlang Module Definition						   et_viewer(3erl)

NAME

       et_viewer - Displays a sequence chart for trace events (messages/actions)

DESCRIPTION

EXPORTS

       file(FileName) -> {ok, ViewerPid} | {error, Reason}

	      Types  FileName() = string()
		     ViewerPid = pid()
		     Reason = term()

	      Start a new event viewer and a corresponding collector and load them with trace events from a trace file.

       start() -> ok

	      Simplified start of a sequence chart viewer with global tracing activated.

	      Convenient to be used from the command line (erl -s et_viewer).

       start(Options) -> ok

	      Start of a sequence chart viewer without linking to the parent process.

       start_link(Options) -> {ok, ViewerPid} | {error, Reason}

	      Types  Options = [option() | collector_option()]
		     option()  =  {parent_pid,	extended_pid()}  |  {title, term()} | {detail_level, detail_level()} | {is_suspended, boolean()} |
		     {scale,  integer()}  |  {width,  integer()}  |  {height,  integer()}  |  {collector_pid,  extended_pid()}	 |   {event_order,
		     event_order()} | {active_filter, atom()} | {max_actors, extended_integer()} | {trace_pattern, et_collector_trace_pattern()} |
		     {trace_port,  et_collector_trace_port()}  |   {trace_global,   et_collector_trace_global()}   |   {trace_client,	et_collec-
		     tor_trace_client()}  |  {dict_insert,  {filter,  filter_name()}, event_filter_fun()} | {dict_insert, et_collector_dict_key(),
		     et_collector_dict_val()} |  {dict_delete,	{filter,  filter_name()}}  |  {dict_delete,  et_collector_dict_key()}  |  {actors,
		     actors()}	|  {first_event,  first_key()}	|  {hide_unknown,  boolean()}  |  {hide_actions,  boolean()} | {display_mode, dis-
		     play_mode()}
		     extended_pid() = pid() | undefined
		     detail_level() = min | max | integer(X) when X >=0, X =< 100
		     event_order() = trace_ts | event_ts
		     extended_integer() = integer() | infinity
		     display_mode() = all | {search_actors, direction(), first_key(), actors()}
		     direction() = forward | reverse
		     first_key() = event_key()
		     actors() = [term()]

		     filter_name() = atom()
		     filter_fun() = fun(Event) -> false | true | {true, NewEvent}
		     Event = NewEvent = record(event)
		     ViewerPid = pid()
		     Reason = term()

	      Start a sequence chart viewer for trace events (messages/actions)

	      A filter_fun() takes an event record as sole argument and returns false | true | {true, NewEvent}.

	      If the collector_pid is undefined a new et_collector will be started with the following parameter settings: parent_pid , event_order
	      ,  trace_global , trace_pattern , trace_port , trace_max_queue , trace_client , dict_insert and dict_delete . The new et_viewer will
	      register itself as an et_collector subscriber.

	      Default values:

		* parent_pid - self().

		* title - "et_viewer".

		* detail_level - max.

		* is_suspended - false.

		* scale - 2.

		* width - 800.

		* height - 600.

		* collector_pid - undefined.

		* event_order - trace_ts.

		* active_filter - collector.

		* max_actors - 5.

		* actors - ["UNKNOWN"].

		* first_event - first.

		* hide_unknown - false.

		* hide_actions - false.

		* display_mode - all.

       get_collector_pid(ViewerPid) -> CollectorPid

	      Types  ViewerPid = pid()
		     CollectorPid = pid()

	      Returns the identifier of the collector process.

       stop(ViewerPid) -> ok

	      Types  ViewerPid = pid()

	      Stops a viewer process.

Ericsson AB							     et 1.4.2							   et_viewer(3erl)

pg2(3erl)						     Erlang Module Definition							 pg2(3erl)

NAME

       pg2 - Distributed Named Process Groups

DESCRIPTION

       This module implements process groups. The groups in this module differ from the groups in the module pg in several ways. In pg , each mes-
       sage is sent to all members in the group. In this module, each message may be sent to one, some, or all members.

       A group of processes can be accessed by a common name. For example, if there is a group named foobar , there can  be  a	set  of  processes
       (which  can be located on different nodes) which are all members of the group foobar . There are no special functions for sending a message
       to the group. Instead, client functions should be written with the functions get_members/1 and get_local_members/1 to find out  which  pro-
       cesses are members of the group. Then the message can be sent to one or more members of the group.

       If a member terminates, it is automatically removed from the group.

   Warning:
       This module is used by the disk_log module for managing distributed disk logs. The disk log names are used as group names, which means that
       some action may need to be taken to avoid name clashes.

EXPORTS

       create(Name) -> void()

	      Types  Name = term()

	      Creates a new, empty process group. The group is globally visible on all nodes. If the group exists, nothing happens.

       delete(Name) -> void()

	      Types  Name = term()

	      Deletes a process group.

       get_closest_pid(Name) -> Pid | {error, Reason}

	      Types  Name = term()
		     Pid = pid()
		     Reason = {no_process, Name} | {no_such_group, Name}

	      This is a useful dispatch function which can be used from client functions. It returns a process	on  the  local	node,  if  such  a
	      process exist. Otherwise, it chooses one randomly.

       get_members(Name) -> [Pid] | {error, Reason}

	      Types  Name = term()
		     Pid = pid()
		     Reason = {no_such_group, Name}

	      Returns  all processes in the group Name . This function should be used from within a client function that accesses the group. It is
	      therefore optimized for speed.

       get_local_members(Name) -> [Pid] | {error, Reason}

	      Types  Name = term()
		     Pid = pid()
		     Reason = {no_such_group, Name}

	      Returns all processes running on the local node in the group Name . This function should to be used from within  a  client  function
	      that accesses the group. It is therefore optimized for speed.

       join(Name, Pid) -> ok | {error, Reason}

	      Types  Name = term()
		     Pid = pid()
		     Reason = {no_such_group, Name}

	      Joins  the process Pid to the group Name . A process can join a group several times; it must then leave the group the same number of
	      times.

       leave(Name, Pid) -> ok | {error, Reason}

	      Types  Name = term()
		     Pid = pid()
		     Reason = {no_such_group, Name}

	      Makes the process Pid leave the group Name . If the process is not a member of the group, ok is returned.

       which_groups() -> [Name]

	      Types  Name = term()

	      Returns a list of all known groups.

       start()
       start_link() -> {ok, Pid} | {error, Reason}

	      Types  Pid = pid()
		     Reason = term()

	      Starts the pg2 server. Normally, the server does not need to be started explicitly, as it is started dynamically if  it  is  needed.
	      This  is useful during development, but in a target system the server should be started explicitly. Use configuration parameters for
	      kernel for this.

SEE ALSO

       kernel(7) , pg(3erl)

Ericsson AB							   kernel 2.14.3							 pg2(3erl)