View Source erldist_filter_nif (erldist_filter v1.28.5)

Summary

Types

action()

action_emit()

action_log()

channel()

channel_inspection()

connection_id()

creation()

distribution_flags()

logger()

logger_event()

logger_event_atoms()

logger_event_control()

logger_event_payload()

logger_inspection()

logger_select_handle()

logger_time()

packet_size()

router_info()

sysname()

world_stat_group_channel()

world_stat_group_memory()

world_stats()

Functions

altact_sig_flags()

atom2cix(Atom)

atom_text_get(Atom, AtomEncoding)

atom_text_put(AtomText, AtomEncoding)

channel_close(Channel)

channel_inspect(Channel)

channel_list()

channel_list(Sysname)

channel_open(PacketSize, Sysname, Creation, ConnectionId, DistributionFlags)

channel_recv(Channel, Input)

channel_set_controlling_process(Channel, NewOwnerPid)

channel_set_tracing_process(Channel, NewTracePid)

config_get()

config_get(ConfigKey)

config_set(ConfigMapSet)

config_set(ConfigKey, ConfigVal)

dist_ext_to_term(AtomsTuple, InputBinary)

dist_ext_to_vdist(AtomsTuple, InputBinary)

dist_ext_to_vterm(AtomsTuple, InputBinary)

dist_ext_to_vterm(AtomsTuple, InputBinary, Limit)

dist_int_to_vdist(AtomsTuple, InputBinary)

dist_int_to_vterm(AtomsTuple, InputBinary)

dist_int_to_vterm(AtomsTuple, InputBinary, Limit)

distribution_flags()

internal_hash(Term)

logger_close(Logger)

logger_inspect(Logger)

logger_list()

logger_open()

logger_recv(Logger)

logger_set_capacity(NewCapacity)

logger_set_controlling_process(Logger, NewOwnerPid)

otp_name_blocklist()

otp_name_is_blocked(Name)

router_info()

router_name(Sysname)

spawn_flags()

version()

world_stats_get()

Types

action()

-type action() :: action_emit() | action_log().

action_emit()

-type action_emit() :: {emit, binary()}.

action_log()

-type action_log() :: {log, non_neg_integer(), {logger_time(), logger_event()}}.

channel()

-type channel() :: erlang:nif_resource().

channel_inspection()

-type channel_inspection() ::
    #{controlling_process := pid(),
      entry :=
          #{connection_id := connection_id(),
            creation := creation(),
            dflags := distribution_flags(),
            sysname := sysname()},
      rx :=
          #{atom_cache := [{0..2047, atom()}],
            ioq_size := non_neg_integer(),
            packet_size := non_neg_integer(),
            stats := erldist_filter_nif_types:channel_stats(),
            vec_capacity := non_neg_integer(),
            vec_len := non_neg_integer()},
      tracing_process := undefined | pid()}.

connection_id()

-type connection_id() :: 0..4294967295.

creation()

-type creation() :: 0..4294967295.

distribution_flags()

-type distribution_flags() :: 0..18446744073709551615.

logger()

-type logger() :: erlang:nif_resource().

logger_event()

-type logger_event() ::
    {sysname(), logger_event_atoms(), logger_event_control(), logger_event_payload()}.

logger_event_atoms()

-type logger_event_atoms() :: tuple() | dynamic().

logger_event_control()

-type logger_event_control() :: undefined | binary().

logger_event_payload()

-type logger_event_payload() :: undefined | binary().

logger_inspection()

-type logger_inspection() ::
    #{controlling_process := pid(), dropped := non_neg_integer(), received := non_neg_integer()}.

logger_select_handle()

-type logger_select_handle() :: reference().

logger_time()

-type logger_time() :: integer().

packet_size()

-type packet_size() :: 0 | 1 | 2 | 4 | 8.

router_info()

-type router_info() :: #{count := pos_integer(), limit := pos_integer(), names := [atom()]}.

sysname()

-type sysname() :: node().

world_stat_group_channel()

-type world_stat_group_channel() ::
    #{create := non_neg_integer(),
      destroy := non_neg_integer(),
      rx_stats := erldist_filter_nif_types:channel_stats()}.

world_stat_group_memory()

-type world_stat_group_memory() ::
    #{vec_own_bin_create := non_neg_integer(),
      vec_own_bin_create_capacity := non_neg_integer(),
      vec_own_bin_realloc := non_neg_integer(),
      vec_own_bin_realloc_capacity := non_neg_integer(),
      vec_own_bin_destroy := non_neg_integer(),
      vec_own_mem_create := non_neg_integer(),
      vec_own_mem_create_capacity := non_neg_integer(),
      vec_own_mem_realloc := non_neg_integer(),
      vec_own_mem_realloc_capacity := non_neg_integer(),
      vec_own_mem_destroy := non_neg_integer(),
      vec_ref_bin_create := non_neg_integer(),
      vec_ref_bin_destroy := non_neg_integer(),
      vec_ref_ioq_create := non_neg_integer(),
      vec_ref_ioq_destroy := non_neg_integer()}.

world_stats()

-type world_stats() ::
    #{channel := world_stat_group_channel(),
      memory := world_stat_group_memory(),
      slots := non_neg_integer()}.

Functions

altact_sig_flags()

-spec altact_sig_flags() -> erldist_filter_nif_types:altact_sig_flags().

atom2cix(Atom)

-spec atom2cix(Atom) -> CacheIndex when Atom :: atom(), CacheIndex :: integer().

atom_text_get(Atom, AtomEncoding)

-spec atom_text_get(Atom, AtomEncoding) -> error | AtomText
                 when Atom :: atom(), AtomEncoding :: latin1 | utf8, AtomText :: binary().

atom_text_put(AtomText, AtomEncoding)

-spec atom_text_put(AtomText, AtomEncoding) -> Atom
                 when AtomText :: binary(), AtomEncoding :: latin1 | utf8, Atom :: atom().

channel_close(Channel)

-spec channel_close(Channel :: channel()) -> ok | {error, closed | not_owner}.

channel_inspect(Channel)

-spec channel_inspect(Channel :: channel()) -> channel_inspection().

channel_list()

-spec channel_list() -> [channel()].

channel_list(Sysname)

-spec channel_list(Sysname) -> [channel()] when Sysname :: sysname().

channel_open(PacketSize, Sysname, Creation, ConnectionId, DistributionFlags)

-spec channel_open(PacketSize, Sysname, Creation, ConnectionId, DistributionFlags) -> Channel
                when
                    PacketSize :: packet_size(),
                    Sysname :: sysname(),
                    Creation :: creation(),
                    ConnectionId :: connection_id(),
                    DistributionFlags :: distribution_flags(),
                    Channel :: channel().

channel_recv(Channel, Input)

-spec channel_recv(Channel :: channel(), Input :: binary() | erlang:iovec()) -> [action()].

channel_set_controlling_process(Channel, NewOwnerPid)

-spec channel_set_controlling_process(Channel, NewOwnerPid) -> ok | {error, Reason}
                                   when
                                       Channel :: channel(),
                                       NewOwnerPid :: pid(),
                                       Reason :: closed | not_owner.

channel_set_tracing_process(Channel, NewTracePid)

-spec channel_set_tracing_process(Channel, NewTracePid) -> ok | {error, Reason}
                               when
                                   Channel :: channel(),
                                   NewTracePid :: pid(),
                                   Reason :: closed | not_owner.

config_get()

-spec config_get() -> ConfigMap when ConfigMap :: erldist_filter_nif_types:config_map().

config_get(ConfigKey)

-spec config_get(ConfigKey) -> ConfigVal
              when ConfigKey :: erldist_filter_nif_types:config_key(), ConfigVal :: boolean().

config_set(ConfigMapSet)

-spec config_set(ConfigMapSet) -> ok when ConfigMapSet :: erldist_filter_nif_types:config_map_set().

config_set(ConfigKey, ConfigVal)

-spec config_set(ConfigKey, ConfigVal) -> ok
              when ConfigKey :: erldist_filter_nif_types:config_key(), ConfigVal :: boolean().

dist_ext_to_term(AtomsTuple, InputBinary)

-spec dist_ext_to_term(AtomsTuple, InputBinary) -> Term
                    when
                        AtomsTuple :: logger_event_atoms(),
                        InputBinary :: binary(),
                        Term :: dynamic().

dist_ext_to_vdist(AtomsTuple, InputBinary)

-spec dist_ext_to_vdist(AtomsTuple, InputBinary) -> VDist
                     when
                         AtomsTuple :: logger_event_atoms(),
                         InputBinary :: binary(),
                         VDist :: vdist:dop_t().

dist_ext_to_vterm(AtomsTuple, InputBinary)

-spec dist_ext_to_vterm(AtomsTuple, InputBinary) -> VTerm
                     when
                         AtomsTuple :: logger_event_atoms(),
                         InputBinary :: binary(),
                         VTerm :: vterm:t().

dist_ext_to_vterm(AtomsTuple, InputBinary, Limit)

-spec dist_ext_to_vterm(AtomsTuple, InputBinary, Limit) -> VTerm
                     when
                         AtomsTuple :: logger_event_atoms(),
                         InputBinary :: binary(),
                         Limit :: integer(),
                         VTerm :: vterm:t().

dist_int_to_vdist(AtomsTuple, InputBinary)

-spec dist_int_to_vdist(AtomsTuple, InputBinary) -> VDist
                     when
                         AtomsTuple :: logger_event_atoms(),
                         InputBinary :: binary(),
                         VDist :: vdist:dop_t().

dist_int_to_vterm(AtomsTuple, InputBinary)

-spec dist_int_to_vterm(AtomsTuple, InputBinary) -> VTerm
                     when
                         AtomsTuple :: logger_event_atoms(),
                         InputBinary :: binary(),
                         VTerm :: vterm:t().

dist_int_to_vterm(AtomsTuple, InputBinary, Limit)

-spec dist_int_to_vterm(AtomsTuple, InputBinary, Limit) -> VTerm
                     when
                         AtomsTuple :: logger_event_atoms(),
                         InputBinary :: binary(),
                         Limit :: integer(),
                         VTerm :: vterm:t().

distribution_flags()

-spec distribution_flags() -> erldist_filter_nif_types:distribution_flags().

internal_hash(Term)

-spec internal_hash(Term) -> Hash when Term :: term(), Hash :: integer().

logger_close(Logger)

-spec logger_close(Logger) -> ok | {error, Reason} when Logger :: logger(), Reason :: closed | not_owner.

logger_inspect(Logger)

-spec logger_inspect(Logger) -> logger_inspection() | {error, Reason}
                  when Logger :: logger(), Reason :: closed.

logger_list()

-spec logger_list() -> [logger()].

logger_open()

-spec logger_open() -> Logger when Logger :: logger().

logger_recv(Logger)

-spec logger_recv(Logger) -> Select | Batch | {error, Reason}
               when
                   Logger :: logger(),
                   Select :: {select, logger_select_handle()},
                   Batch :: {Size, Drop, [Element]},
                   Size :: non_neg_integer(),
                   Drop :: non_neg_integer(),
                   Element :: {Time, Event},
                   Time :: logger_time(),
                   Event :: logger_event(),
                   Reason :: closed | not_owner.

logger_set_capacity(NewCapacity)

-spec logger_set_capacity(NewCapacity) -> OldCapacity
                       when NewCapacity :: non_neg_integer(), OldCapacity :: non_neg_integer().

logger_set_controlling_process(Logger, NewOwnerPid)

-spec logger_set_controlling_process(Logger, NewOwnerPid) -> ok | {error, Reason}
                                  when
                                      Logger :: logger(),
                                      NewOwnerPid :: pid(),
                                      Reason :: closed | not_owner.

otp_name_blocklist()

-spec otp_name_blocklist() -> BlockList when BlockList :: [atom()].

otp_name_is_blocked(Name)

-spec otp_name_is_blocked(Name) -> IsBlocked when Name :: atom(), IsBlocked :: boolean().

router_info()

-spec router_info() -> RouterInfo when RouterInfo :: router_info().

router_name(Sysname)

-spec router_name(Sysname) -> RouterName when Sysname :: sysname(), RouterName :: atom().

spawn_flags()

-spec spawn_flags() -> erldist_filter_nif_types:spawn_flags().

version()

-spec version() -> non_neg_integer().

world_stats_get()

-spec world_stats_get() -> world_stats().