forked from erlang/signerl
133 lines
4.3 KiB
Erlang
133 lines
4.3 KiB
Erlang
%%% $Id: tcap.erl,v 1.10 2011/03/07 17:21:09 vances Exp $
|
|
%%%---------------------------------------------------------------------
|
|
%%% @copyright 2004-2005 Motivity Telecom
|
|
%%% @author Vance Shipley <vances@motivity.ca> [http://www.motivity.ca]
|
|
%%% @end
|
|
%%%
|
|
%%% Copyright (c) 2004-2005, Motivity Telecom
|
|
%%%
|
|
%%% All rights reserved.
|
|
%%%
|
|
%%% Redistribution and use in source and binary forms, with or without
|
|
%%% modification, are permitted provided that the following conditions
|
|
%%% are met:
|
|
%%%
|
|
%%% - Redistributions of source code must retain the above copyright
|
|
%%% notice, this list of conditions and the following disclaimer.
|
|
%%% - Redistributions in binary form must reproduce the above copyright
|
|
%%% notice, this list of conditions and the following disclaimer in
|
|
%%% the documentation and/or other materials provided with the
|
|
%%% distribution.
|
|
%%% - Neither the name of Motivity Telecom nor the names of its
|
|
%%% contributors may be used to endorse or promote products derived
|
|
%%% from this software without specific prior written permission.
|
|
%%%
|
|
%%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
%%% "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
%%% LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
%%% A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
%%% OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
%%% SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
%%% LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
%%% DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
%%% THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
%%% (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
%%% OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
%%%
|
|
%%%---------------------------------------------------------------------
|
|
%%%
|
|
%%% @doc Transaction Capabilities Application Part
|
|
%%% <p>This module implements the user's API to the TCAP protocol
|
|
%%% stack application.Transaction Capabilities are </p>
|
|
%%%
|
|
%%% @reference <a href="index.html">TCAP User's Guide</a>
|
|
%%%
|
|
|
|
-module(tcap).
|
|
-copyright('Copyright (c) 2004-2005 Motivity Telecom Inc.').
|
|
-author('vances@motivity.ca').
|
|
-vsn('$Revision: 1.10 $').
|
|
|
|
%% our published API functions
|
|
-export([start/0, stop/0]).
|
|
-export([open/3, close/1]).
|
|
%-export([start_tsl/3]).
|
|
-export([dialogueID/1, transactionID/1]).
|
|
|
|
|
|
%% @type tcap_options(). TCAP layer options
|
|
%% <p>A list of one or more of the following tuples.</p>
|
|
%% <dl>
|
|
%% <dt><tt>{variant, Variant}</tt></dt><dd><tt>itu | ansi</tt></dd>
|
|
%% </dl>
|
|
%% @end
|
|
|
|
%%----------------------------------------------------------------------
|
|
%% The API functions
|
|
%%----------------------------------------------------------------------
|
|
|
|
%% @spec () -> Result
|
|
%% Result = ok | {error, Reason}
|
|
%% Reason = term()
|
|
%%
|
|
%% @equiv application:start(tcap)
|
|
%%
|
|
start() ->
|
|
application:start(tcap).
|
|
|
|
%% @spec () -> Result
|
|
%% Result = ok | {error, Reason}
|
|
%% Reason = term()
|
|
%%
|
|
%% @equiv application:stop(tcap)
|
|
%%
|
|
stop() ->
|
|
application:stop(tcap).
|
|
|
|
%% @spec (TSL::pid(), TCU::pid(), Args) -> CSL
|
|
%% Args = [term()]
|
|
%% CSL = {DHA, CCO}
|
|
%% DHA = pid()
|
|
%% CCO = pid()
|
|
%%
|
|
%% @doc Start a new component sublayer (CSL).
|
|
%% <p>Called by the TC-User to initialize the TCAP layer for a new
|
|
%% dialogue.</p>
|
|
%%
|
|
%% <p><tt>TSL</tt> is the pid returned from a previous call to
|
|
%% <a href="#open-3"><tt>open/3</tt></a>.</p>
|
|
%%
|
|
%% <p><tt>TCU</tt> is the pid of the TC-User.</p>
|
|
%%
|
|
%% <p>Returns <tt>{DHA, CCO}</tt>; the pids of the dialogue handler
|
|
%% and component coordinator in the component sublayer.</p>.
|
|
%%
|
|
open(TSL, TCU, Args) ->
|
|
gen_server:call(TSL, {start_dialogue, TCU, Args}).
|
|
|
|
%% @spec (TSL::pid()) -> ok
|
|
%%
|
|
%% @doc Close a TCAP service layer.
|
|
%%
|
|
%% <p><tt>TSL</tt> is the pid returned in a previous call to
|
|
%% <a href="#open-3"><tt>open/3</tt></a>.</p>
|
|
%%
|
|
close(TSL) when is_pid(TSL) ->
|
|
gen_server:call(TSL, close).
|
|
|
|
%% @spec (TSL::pid()) -> tid()
|
|
%%
|
|
%% @doc Assign a new dialogue ID.
|
|
%%
|
|
%% <p><tt>TSL</tt> is the pid returned in a previous call to
|
|
%% <a href="#open-3"><tt>open/3</tt></a>.</p>
|
|
%%
|
|
dialogueID(TSL) when is_pid(TSL) ->
|
|
gen_server:call(TSL, dialogueID).
|
|
|
|
%% @equiv dialogueID/0
|
|
%%
|
|
transactionID(TSL) when is_pid(TSL) ->
|
|
dialogueID(TSL).
|
|
|