Module econfd_maapi

aaa_reload(Socket, Synchronous) -> ok | err()

• Socket = econfd:socket()
• Synchronous = boolean()

abort_trans(Socket, Tid) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()

abort_upgrade(Socket) -> ok | err()

• Socket = econfd:socket()

all_keys(Socket, Tid, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Result = {ok, [econfd:key()]} | err()

apply_trans(Socket, Tid, KeepOpen) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• KeepOpen = boolean()

apply_trans(Socket, Tid, KeepOpen, Flags) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• KeepOpen = boolean()
• Flags = non_neg_integer()

attach(Socket, Ns, Tctx) -> ok | err()

• Socket = econfd:socket()
• Ns = econfd:namespace() | 0
• Tctx = econfd:confd_trans_ctx()

attach2(Socket, Ns, USid, Thandle) -> ok | err()

• Socket = econfd:socket()
• Ns = econfd:namespace() | 0
• USid = integer()
• Thandle = integer()

attach_init(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, Thandle} | err()
• Thandle = integer()

authenticate(Socket, User, Pass, Groups) -> ok | err()

• Socket = econfd:socket()
• User = binary()
• Pass = binary()
• Groups = [binary()]

authenticate2(Socket, User, Pass, SrcIp, SrcPort, Context, Proto, Groups) -> ok | err()

• Socket = econfd:socket()
• User = binary()
• Pass = binary()
• SrcIp = econfd:ip()
• SrcPort = non_neg_integer()
• Context = binary()
• Proto = integer()
• Groups = [binary()]

candidate_abort_commit(Socket) -> ok | err()

• Socket = econfd:socket()

candidate_abort_commit(Socket, PersistId) -> ok | err()

• Socket = econfd:socket()
• PersistId = binary()

candidate_commit(Socket) -> ok | err()

• Socket = econfd:socket()

candidate_commit(Socket, PersistId) -> ok | err()

• Socket = econfd:socket()
• PersistId = binary()

candidate_commit_info(Socket, Label, Comment) -> ok | err()

• Socket = econfd:socket()
• Label = binary()
• Comment = binary()

candidate_commit_info(Socket, PersistId, Label, Comment) -> ok | err()

• Socket = econfd:socket()
• PersistId = binary() | undefined
• Label = binary()
• Comment = binary()

candidate_confirmed_commit(Socket, TimeoutSecs) -> ok | err()

• Socket = econfd:socket()
• TimeoutSecs = integer()

candidate_confirmed_commit(Socket, TimeoutSecs, Persist, PersistId) -> ok | err()

• Socket = econfd:socket()
• TimeoutSecs = integer()
• Persist = binary() | undefined
• PersistId = binary() | undefined

candidate_confirmed_commit_info(Socket, TimeoutSecs, Label, Comment) -> ok | err()

• Socket = econfd:socket()
• TimeoutSecs = integer()
• Label = binary()
• Comment = binary()

candidate_confirmed_commit_info(Socket, TimeoutSecs, Persist, PersistId, Label, Comment) -> ok | err()

• Socket = econfd:socket()
• TimeoutSecs = integer()
• Persist = binary() | undefined
• PersistId = binary() | undefined
• Label = binary()
• Comment = binary()

candidate_reset(Socket) -> ok | err()

• Socket = econfd:socket()

candidate_validate(Socket) -> ok | err()

• Socket = econfd:socket()

cli_prompt(Socket, USid, Prompt, Echo) -> {ok, binary()} | err()

• Socket = econfd:socket()
• USid = integer()
• Prompt = binary()
• Echo = boolean()

cli_prompt(Socket, USid, Prompt, Echo, Timeout) -> {ok, binary()} | err()

• Socket = econfd:socket()
• USid = integer()
• Prompt = binary()
• Echo = boolean()
• Timeout = non_neg_integer()

cli_prompt_oneof(Socket, USid, Prompt, Choice) -> {ok, binary()} | err()

• Socket = econfd:socket()
• USid = integer()
• Prompt = binary()
• Choice = binary()

cli_prompt_oneof(Socket, USid, Prompt, Choice, Timeout) -> {ok, binary()} | err()

• Socket = econfd:socket()
• USid = integer()
• Prompt = binary()
• Choice = binary()
• Timeout = non_neg_integer()

cli_read_eof(Socket, USid, Echo) -> {ok, binary()} | err()

• Socket = econfd:socket()
• USid = integer()
• Echo = boolean()

cli_read_eof(Socket, USid, Echo, Timeout) -> {ok, binary()} | err()

• Socket = econfd:socket()
• USid = integer()
• Echo = boolean()
• Timeout = non_neg_integer()

cli_write(Socket, USid, Message) -> ok | err()

• Socket = econfd:socket()
• USid = integer()
• Message = binary()

close(Socket) -> Result

• Socket = econfd:socket()
• Result = ok | {error, econfd:error_reason()}

commit_trans(Socket, Tid) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()

commit_upgrade(Socket) -> ok | err()

• Socket = econfd:socket()

confirmed_commit_in_progress(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, boolean()} | err()

connect(Path) -> econfd:connect_result()

• Path = string()

connect(Address, Port) -> econfd:connect_result()

• Address = econfd:ip()
• Port = non_neg_integer()

copy(Socket, FromTH, ToTH) -> ok | err()

• Socket = econfd:socket()
• FromTH = integer()
• ToTH = integer()

copy_running_to_startup(Socket) -> ok | err()

• Socket = econfd:socket()

copy_tree(Socket, Tid, FromIKeypath, ToIKeypath) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• FromIKeypath = econfd:ikeypath()
• ToIKeypath = econfd:ikeypath()

create(Socket, Tid, IKeypath) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()

delete(Socket, Tid, IKeypath) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()

delete_config(Socket, DbName) -> ok | err()

• Socket = econfd:socket()
• DbName = dbname()

detach(Socket, Thandle) -> ok | err()

• Socket = econfd:socket()
• Thandle = integer()

diff_iterate(Sock, Tid, Fun, InitState) -> any()

diff_iterate(Socket, Tid, Fun, Flags, State) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Fun = fun((IKeypath, Op, OldValue, Value, State) -> {ok, Ret, State} | {error, term()})
• IKeypath = econfd:ikeypath()
• Op = integer()
• OldValue = econfd:value() | undefined
• Value = econfd:value() | undefined | econfd:key() | {}
• State = term()
• Ret = integer()
• Flags = non_neg_integer()
• Result = {ok, State} | {error, term()}

end_progress_span(Socket, SpanId1, Annotation) -> Result

• Socket = econfd:socket()
• SpanId1 = binary()
• Annotation = iolist()
• Result = {ok, {SpanId2::binary() | undefined, TraceId::binary() | undefined}}

end_user_session(Socket) -> ok | err()

• Socket = econfd:socket()

exists(Socket, Tid, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Result = {ok, boolean()} | err()

find_next(Cursor, Type, Key) -> Result

• Cursor = maapi_cursor()
• Type = find_next_type()
• Key = econfd:key()
• Result = {ok, econfd:key(), Cursor} | done | err()

finish_trans(Socket, Tid) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()

get_attrs(Socket, Tid, IKeypath, AttrList) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• AttrList = [Attr]
• Attr = integer()
• Result = {ok, [{Attr, Value}]} | err()
• Value = econfd:value()

get_authorization_info(Socket, USid) -> Result

• Socket = econfd:socket()
• USid = integer()
• Result = {ok, Info} | err()
• Info = {[Group]}
• Group = binary()

get_case(Socket, Tid, IKeypath, Choice) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Choice = econfd:qtag() | [econfd:qtag()]
• Result = {ok, Case} | err()
• Case = econfd:qtag()

get_elem(Socket, Tid, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Result = {ok, econfd:value()} | err()

get_elem_no_defaults(Socket, Tid, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Result = {ok, Value} | err()
• Value = econfd:value() | default

get_my_user_session_id(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, USid} | err()
• USid = integer()

get_next(Cursor) -> Result

• Cursor = maapi_cursor()
• Result = {ok, econfd:key(), Cursor} | done | err()

get_object(Socket, Tid, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Result = {ok, [econfd:value()]} | err()

get_objects(Cursor, NumEntries) -> Result

• Cursor = maapi_cursor()
• NumEntries = integer()
• Result = {ok, Cursor, Values} | {done, Values} | err()
• Values = [[econfd:value()]]

get_rollback_id(Socket, Tid) -> non_neg_integer() | -1

• Socket = econfd:socket()
• Tid = integer()

get_running_db_status(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, Status} | err()
• Status = Valid | Invalid
• Valid = 1
• Invalid = 0

get_user_session(Socket, USid) -> Result

• Socket = econfd:socket()
• USid = integer()
• Result = {ok, confd_user_info()} | err()

get_user_sessions(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, [USid]} | err()
• USid = integer()

get_values(Socket, Tid, IKeypath, Values) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Values = [econfd:tagval()]
• Result = {ok, [econfd:tagval()]} | err()

hide_group(Socket, Tid, GroupName) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• GroupName = binary()

hkeypath2ikeypath(Socket, HKeypath) -> Result

• Socket = econfd:socket()
• HKeypath = [non_neg_integer()]
• Result = {ok, IKeypath} | err()
• IKeypath = econfd:ikeypath()

init_cursor(Socket, Tid, IKeypath) -> maapi_cursor()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()

init_cursor(Socket, Tid, IKeypath, XPath) -> maapi_cursor()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• XPath = undefined | binary() | string()

init_upgrade(Socket, TimeoutSecs, Flags) -> ok | err()

• Socket = econfd:socket()
• TimeoutSecs = integer()
• Flags = non_neg_integer()

insert(Socket, Tid, IKeypath) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()

install_crypto_keys(Socket) -> ok | err()

• Socket = econfd:socket()

is_candidate_modified(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, boolean()} | err()

is_lock_set(Socket, DbName) -> Result

• Socket = econfd:socket()
• DbName = dbname()
• Result = {ok, integer()} | err()

is_running_modified(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, boolean()} | err()

iterate(Socket, Tid, IKeypath, Fun, Flags, State) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Fun = fun((IKeypath, Value, Attrs, State) -> {ok, Ret, State} | {error, term()})
• Value = econfd:value() | undefined
• Attrs = [{Attr, Value}] | undefined
• Attr = integer()
• State = term()
• Ret = integer()
• Flags = non_neg_integer()
• Result = {ok, State} | {error, term()}

keypath_diff_iterate(Socket, Tid, IKeypath, Fun, State) -> Result

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Fun = fun((IKeypath, Op, OldValue, Value, State) -> {ok, Ret, State} | {error, term()})
• Op = integer()
• OldValue = econfd:value()
• Value = econfd:value() | econfd:key()
• State = term()
• Ret = integer()
• Result = {ok, State} | {error, term()}

keypath_diff_iterate(Sock, Tid, IKP, Fun, Flags, InitState) -> any()

kill_user_session(Socket, USid) -> ok | err()

• Socket = econfd:socket()
• USid = integer()

list_rollbacks(Socket) -> Result

• Socket = econfd:socket()
• Result = {ok, [maapi_rollback()]} | err()

load_rollback(Socket, Tid, Id) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• Id = integer() | {fixed, integer()}

lock(Socket, DbName) -> ok | err()

• Socket = econfd:socket()
• DbName = dbname()

lock_partial(Socket, DbName, XPath) -> Result

• Socket = econfd:socket()
• DbName = dbname()
• XPath = [binary()]
• Result = {ok, LockId} | err()
• LockId = integer()

move(Socket, Tid, IKeypath, ToKey) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• ToKey = econfd:key()

move_ordered(Socket, Tid, IKeypath, To) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• To = first | last | {before | 'after', econfd:key()}

ncs_apply_template(Socket, Tid, TemplateName, RootIKeypath, Variables, Documents, Shared) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• TemplateName = binary()
• RootIKeypath = econfd:ikeypath()
• Variables = term()
• Documents = term()
• Shared = boolean()

ncs_apply_trans_params(Socket, Tid, KeepOpen, Params) -> Result

• Socket = econfd:socket()
• Tid = integer()
• KeepOpen = boolean()
• Params = [econfd:tagval()]
• Result = ok | {ok, [econfd:tagval()]} | err()

ncs_get_trans_params(Socket, Tid) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Result = {ok, [econfd:tagval()]} | err()

ncs_template_variables(Socket, Tid, TemplateName) -> {ok, binary()} | err()

• Socket = econfd:socket()
• Tid = integer()
• TemplateName = binary()

ncs_templates(Socket) -> {ok, binary()} | err()

• Socket = econfd:socket()

ncs_write_service_log_entry(Socket, IKeypath, Message, Type, Level) -> ok | err()

• Socket = econfd:socket()
• IKeypath = econfd:ikeypath()
• Message = string()
• Type = econfd:value()
• Level = econfd:value()

netconf_ssh_call_home(Socket, Host, Port) -> ok | err()

• Socket = econfd:socket()
• Host = econfd:ip() | string()
• Port = non_neg_integer()

netconf_ssh_call_home_opaque(Socket, Host, Opaque, Port) -> ok | err()

• Socket = econfd:socket()
• Host = econfd:ip() | string()
• Opaque = string()
• Port = non_neg_integer()

num_instances(Socket, Tid, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = non_neg_integer()
• IKeypath = econfd:ikeypath()
• Result = {ok, integer()} | err()

perform_upgrade(Socket, LoadPathList) -> ok | err()

• Socket = econfd:socket()
• LoadPathList = [binary()]

prepare_trans(Socket, Tid) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()

prepare_trans(Socket, Tid, Flags) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• Flags = non_neg_integer()

prio_message(Socket, To, Message) -> ok | err()

• Socket = econfd:socket()
• To = binary()
• Message = binary()

progress_info(Socket, Verbosity, Msg, SIKP, Attrs, Links) -> ok

• Socket = econfd:socket()
• Verbosity = verbosity()
• Msg = iolist()
• SIKP = econfd:ikeypath()
• Attrs = [{K::binary(), V::binary() | integer()}]
• Links = [{TraceId::binary() | undefined, SpanId::binary() | undefined}]

progress_info_th(Socket, Tid, Verbosity, Msg, SIKP, Attrs, Links) -> ok

• Socket = econfd:socket()
• Tid = integer()
• Verbosity = verbosity()
• Msg = iolist()
• SIKP = econfd:ikeypath()
• Attrs = [{K::binary(), V::binary() | integer()}]
• Links = [{TraceId::binary() | undefined, SpanId::binary() | undefined}]

reload_config(Socket) -> ok | err()

• Socket = econfd:socket()

request_action(Socket, Params, IKeypath) -> Result

• Socket = econfd:socket()
• Params = [econfd:tagval()]
• IKeypath = econfd:ikeypath()
• Result = ok | {ok, [econfd:tagval()]} | err()

request_action_th(Socket, Tid, Params, IKeypath) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Params = [econfd:tagval()]
• IKeypath = econfd:ikeypath()
• Result = ok | {ok, [econfd:tagval()]} | err()

revert(Socket, Tid) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()

set_attr(Socket, Tid, IKeypath, Attr, Value) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Attr = integer()
• Value = econfd:value() | undefined

set_comment(Socket, Tid, Comment) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• Comment = binary()

set_delayed_when(Socket, Tid, Value) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Value = boolean()
• Result = {ok, OldValue} | err()
• OldValue = boolean()

set_elem(Socket, Tid, IKeypath, Value) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Value = econfd:value()

set_elem2(Socket, Tid, IKeypath, BinValue) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• BinValue = binary()

set_flags(Socket, Tid, Flags) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• Flags = non_neg_integer()

set_label(Socket, Tid, Label) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• Label = binary()

set_object(Socket, Tid, IKeypath, ValueList) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• ValueList = [econfd:value()]

set_readonly_mode(Socket, Mode) -> {ok, boolean()} | err()

• Socket = econfd:socket()
• Mode = boolean()

set_running_db_status(Socket, Status) -> ok | err()

• Socket = econfd:socket()
• Status = Valid | InValid
• Valid = 1
• InValid = 0

set_user_session(Socket, USid) -> ok | err()

• Socket = econfd:socket()
• USid = integer()

set_values(Socket, Tid, IKeypath, ValueList) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• ValueList = [econfd:tagval()]

shared_create(Socket, Tid, IKeypath) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()

shared_set_elem(Socket, Tid, IKeypath, Value) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• Value = econfd:value()

shared_set_elem2(Socket, Tid, IKeypath, BinValue) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• BinValue = binary()

shared_set_values(Socket, Tid, IKeypath, ValueList) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• IKeypath = econfd:ikeypath()
• ValueList = [econfd:tagval()]

snmpa_reload(Socket, Synchronous) -> ok | err()

• Socket = econfd:socket()
• Synchronous = boolean()

start_phase(Socket, Phase, Synchronous) -> ok | err()

• Socket = econfd:socket()
• Phase = 1 | 2
• Synchronous = boolean()

start_progress_span(Socket, Verbosity, Msg, SIKP, Attrs, Links) -> Result

• Socket = econfd:socket()
• Verbosity = verbosity()
• Msg = iolist()
• SIKP = econfd:ikeypath()
• Attrs = [{K::binary(), V::binary() | integer()}]
• Links = [{TraceId::binary() | undefined, SpanId1::binary() | undefined}]
• Result = {ok, {SpanId2::binary() | undefined, TraceId::binary() | undefined}}

start_progress_span_th(Socket, Tid, Verbosity, Msg, SIKP, Attrs, Links) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Verbosity = verbosity()
• Msg = iolist()
• SIKP = econfd:ikeypath()
• Attrs = [{K::binary(), V::binary() | integer()}]
• Links = [{TraceId::binary() | undefined, SpanId1::binary() | undefined}]
• Result = {ok, {SpanId2::binary() | undefined, TraceId::binary() | undefined}}

start_trans(Socket, DbName, RwMode) -> Result

• Socket = econfd:socket()
• DbName = dbname()
• RwMode = integer()
• Result = {ok, integer()} | err()

start_trans(Socket, DbName, RwMode, USid) -> Result

• Socket = econfd:socket()
• DbName = dbname()
• RwMode = integer()
• USid = integer()
• Result = {ok, integer()} | err()

start_trans(Socket, DbName, RwMode, USid, Flags) -> Result

• Socket = econfd:socket()
• DbName = dbname()
• RwMode = integer()
• USid = integer()
• Flags = non_neg_integer()
• Result = {ok, integer()} | err()

start_trans_in_trans(Socket, RwMode, USid, Tid) -> Result

• Socket = econfd:socket()
• RwMode = integer()
• USid = integer()
• Tid = integer()
• Result = {ok, integer()} | err()

start_trans_in_trans(Socket, RwMode, USid, Tid, Flags) -> Result

• Socket = econfd:socket()
• RwMode = integer()
• USid = integer()
• Tid = integer()
• Flags = non_neg_integer()
• Result = {ok, integer()} | err()

start_user_session(Socket, UserName, Context, Groups, SrcIp, Proto) -> ok | err()

• Socket = econfd:socket()
• UserName = binary()
• Context = binary()
• Groups = [binary()]
• SrcIp = econfd:ip()
• Proto = proto()

start_user_session(Socket, UserName, Context, Groups, SrcIp, SrcPort, Proto) -> ok | err()

• Socket = econfd:socket()
• UserName = binary()
• Context = binary()
• Groups = [binary()]
• SrcIp = econfd:ip()
• SrcPort = non_neg_integer()
• Proto = proto()

start_user_session(Socket, UserName, Context, Groups, SrcIp, SrcPort, Proto, UId) -> ok | err()

• Socket = econfd:socket()
• UserName = binary()
• Context = binary()
• Groups = [binary()]
• SrcIp = econfd:ip()
• SrcPort = non_neg_integer()
• Proto = proto()
• UId = confd_user_identification() | undefined

stop(Socket) -> ok

• Socket = econfd:socket()

stop(Socket, Synchronous) -> ok

• Socket = econfd:socket()
• Synchronous = boolean()

sys_message(Socket, To, Message) -> ok | err()

• Socket = econfd:socket()
• To = binary()
• Message = binary()

unhide_group(Socket, Tid, GroupName) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• GroupName = binary()

unlock(Socket, DbName) -> ok | err()

• Socket = econfd:socket()
• DbName = dbname()

unlock_partial(Socket, LockId) -> ok | err()

• Socket = econfd:socket()
• LockId = integer()

user_message(Socket, To, From, Message) -> ok | err()

• Socket = econfd:socket()
• To = binary()
• From = binary()
• Message = binary()

validate_trans(Socket, Tid, UnLock, ForceValidation) -> ok | err()

• Socket = econfd:socket()
• Tid = integer()
• UnLock = boolean()
• ForceValidation = boolean()

wait_start(Socket) -> ok | err()

• Socket = econfd:socket()

wait_start(Socket, Phase) -> ok | err()

• Socket = econfd:socket()
• Phase = 1 | 2

xpath_eval(Socket, Tid, Expr, ResultFun, State, Options) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Expr = binary() | {compiled, Source, Compiled}
• Source = binary()
• Compiled = [binary() | tuple()]
• ResultFun = fun((IKeypath, Value, State) -> {Ret, State})
• IKeypath = econfd:ikeypath()
• Value = term()
• State = term()
• Ret = integer()
• Options = [xpath_eval_option()]
• Result = {ok, State} | err()

xpath_eval(Socket, Tid, Expr, ResultFun, TraceFun, State, Context) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Expr = binary()
• ResultFun = fun((IKeypath, Value, State) -> {Ret, State})
• IKeypath = econfd:ikeypath()
• Value = econfd:value() | undefined
• State = term()
• Ret = integer()
• TraceFun = fun((binary()) -> none()) | undefined
• Context = econfd:ikeypath() | []
• Result = {ok, State} | {error, term()}

xpath_eval_expr(Socket, Tid, Expr, Options) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Expr = binary() | {compiled, Source, Compiled}
• Source = binary()
• Compiled = [binary() | tuple()]
• Options = [xpath_eval_option()]
• Result = {ok, binary()} | err()

xpath_eval_expr(Socket, Tid, Expr, TraceFun, Context) -> Result

• Socket = econfd:socket()
• Tid = integer()
• Expr = binary()
• TraceFun = fun((binary()) -> none()) | undefined
• Context = econfd:ikeypath() | []
• Result = {ok, binary()} | err()