From 654d3f45431e57512597792376524b56805a1829 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Tue, 28 Aug 2012 10:44:01 +0200 Subject: Terminology and other clarifications, more references Diameter node/peer having been the most vicious terminology blunder. --- lib/diameter/doc/src/diameter.xml | 206 ++++++++++++++++------------ lib/diameter/doc/src/diameter_app.xml | 111 ++++++++------- lib/diameter/doc/src/diameter_sctp.xml | 6 +- lib/diameter/doc/src/diameter_tcp.xml | 8 +- lib/diameter/doc/src/diameter_transport.xml | 4 +- 5 files changed, 189 insertions(+), 146 deletions(-) (limited to 'lib') diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml index 10139b90c7..6abd1515c9 100644 --- a/lib/diameter/doc/src/diameter.xml +++ b/lib/diameter/doc/src/diameter.xml @@ -49,7 +49,7 @@ Diameter protocol as defined in RFC 3588.

Basic usage consists of creating a representation of a -locally implemented Diameter peer and its capabilities with start_service/2, adding transport capability using add_transport/2 and sending Diameter @@ -84,13 +84,14 @@ this module.

Address() DiameterIdentity() +Grouped() +OctetString() Time() Unsigned32() -UTF8String()

Types corresponding to RFC 3588 AVP Data Formats. -Defined in diameter_dict(4).

+Defined in diameter_dict(4).

 @@ -148,7 +149,7 @@ Options defining a Diameter application as configured in an -{alias, application_alias()} +{alias, application_alias()}

An unique identifier for the application in the scope of the @@ -166,7 +167,7 @@ documented in diameter_dict(4).

 -{module, application_module()} +{module, application_module()}

A callback module with which messages of the Diameter application are @@ -253,7 +254,7 @@ itself. Multiple options append to the argument list.

 -{filter, peer_filter()} +{filter, peer_filter()}

A filter to apply to the list of available peers before passing them to @@ -264,7 +265,7 @@ corresponding list of filters. Defaults to none.

 -{timeout, Unsigned32()} +{timeout, Unsigned32()}

The number of milliseconds after which the request should @@ -304,19 +305,19 @@ precedence over the former.

-{'Origin-Host', DiameterIdentity()} +{'Origin-Host', DiameterIdentity()}

Value of the Origin-Host AVP in outgoing messages.

 -{'Origin-Realm', DiameterIdentity()} +{'Origin-Realm', DiameterIdentity()}

Value of the Origin-Realm AVP in outgoing messages.

 -{'Host-IP-Address', [Address()]} +{'Host-IP-Address', [Address()]}

Values of Host-IP-Address AVPs. @@ -325,26 +326,25 @@ Optional.

The list of addresses is available to the start function of a transport module, which either uses them as is or returns a new list -(typically as configured as transport_config() on the -transport module in question) in order for the correct list of -addresses to be sent in capabilities exchange messages.

+in order for the correct list of addresses to be sent in capabilities +exchange messages.

 -{'Vendor-Id', Unsigned32()} +{'Vendor-Id', Unsigned32()}

Value of the Vendor-Id AVP sent in an outgoing capabilities exchange message.

 -{'Product-Name', UTF8String()} +{'Product-Name', UTF8String()}

Value of the Product-Name AVP sent in an outgoing capabilities exchange message.

 -{'Origin-State-Id', Unsigned32()} +{'Origin-State-Id', Unsigned32()}

Value of Origin-State-Id to be included in outgoing messages sent by @@ -361,7 +361,7 @@ can be used as to retrieve a value that is set when the diameter application is started.

 -{'Supported-Vendor-Id', [Unsigned32()]} +{'Supported-Vendor-Id', [Unsigned32()]}

Values of Supported-Vendor-Id AVPs sent in an outgoing @@ -369,7 +369,7 @@ capabilities exchange message. Optional, defaults to the empty list.

 -{'Auth-Application-Id', [Unsigned32()]} +{'Auth-Application-Id', [Unsigned32()]}

Values of Auth-Application-Id AVPs sent in an outgoing @@ -377,7 +377,7 @@ capabilities exchange message. Optional, defaults to the empty list.

 -{'Inband-Security-Id', [Unsigned32()]} +{'Inband-Security-Id', [Unsigned32()]}

Values of Inband-Security-Id AVPs sent in an outgoing @@ -390,7 +390,7 @@ If 1 (= TLS) is specified then TLS is selected if the CER/CEA received from the peer offers it.

 -{'Acct-Application-Id', [Unsigned32()]} +{'Acct-Application-Id', [Unsigned32()]}

Values of Acct-Application-Id AVPs sent in an outgoing @@ -398,7 +398,7 @@ capabilities exchange message. Optional, defaults to the empty list.

 -{'Vendor-Specific-Application-Id', [Grouped()]} +{'Vendor-Specific-Application-Id', [Grouped()]}

Values of Vendor-Specific-Application-Id AVPs sent in @@ -406,7 +406,7 @@ an outgoing capabilities exchange message. Optional, defaults to the empty list.

 -{'Firmware-Revision', Unsigned32()} +{'Firmware-Revision', Unsigned32()}

Value of the Firmware-Revision AVP sent in an outgoing capabilities @@ -490,41 +490,42 @@ or any peer if the request does not contain a Destination-Realm AVP.

 -{host, any|DiameterIdentity()} +{host, any|DiameterIdentity()}

Matches only those peers whose Origin-Host has the specified value, or all peers if the atom any.

 -{realm, any|DiameterIdentity() +{realm, any|DiameterIdentity()

Matches only those peers whose Origin-Realm has the value, or all peers if the atom any.

 -{eval, evaluable()} +{eval, evaluable()}

-Matches only those peers for which the specified evaluable() returns +Matches only those peers for which the specified #evaluable() returns true on the connection's diameter_caps record. Any other return value or exception is equivalent to false.

 -{neg, peer_filter()} +{neg, peer_filter()}

Matches only those peers not matched by the specified filter.

 -{all, [peer_filter()]} +{all, [peer_filter()]}

Matches only those peers matched by each filter of the specified list.

 -{any, [peer_filter()]} +{any, [peer_filter()]}

Matches only those peers matched by at least one filter of the @@ -536,10 +537,11 @@ specified list.

Note that the host and realm filters examine the outgoing request as passed to call/4, -assuming that this is a record- or list-valued message() as documented -in diameter_app(3), and that +assuming that this is a record- or list-valued diameter_app:message(), and that the message contains at most one of each AVP. -If this is not the case then the {host|realm, DiameterIdentity()} +If this is not the case then the {host|realm, DiameterIdentity()} filters must be used to achieve the desired result. Note also that an empty host/realm (which should not be typical) is equivalent to an unspecified one for the purposes of filtering.

@@ -568,9 +570,9 @@ following.

{down, Ref, Peer, Config} -Ref = transport_ref() -Peer = diameter_app:peer() -Config = {connect|listen, [transport_opt()]} +Ref = transport_ref() +Peer = diameter_app:peer() +Config = {connect|listen, [transport_opt()]} Pkt = #diameter_packet{} @@ -587,8 +589,8 @@ connectivity.

Note that a single up/down event for a given peer corresponds to as many peer_up/peer_down -callbacks as there are Diameter applications shared by the peer, -as determined during capablilities exchange. +callbacks as there are Diameter applications that have been negotiated +during capablilities exchange. That is, the event communicates connectivity with the peer as a whole while the callbacks communicate connectivity with respect to individual Diameter applications.

@@ -597,8 +599,8 @@ respect to individual Diameter applications.

{reconnect, Ref, Opts} -Ref = transport_ref() -Opts = [transport_opt()] +Ref = transport_ref() +Opts = [transport_opt()]

@@ -610,8 +612,8 @@ transport connection with a peer following reconnect_timer or {closed, Ref, Reason, Config} -Ref = transport_ref() -Config = {connect|listen, [transport_opt()]} +Ref = transport_ref() +Config = {connect|listen, [transport_opt()]}

@@ -627,7 +629,7 @@ Result = ResultCode | {capabilities_cb, CB, ResultCode|discard} Caps = #diameter_caps{} Pkt = #diameter_packet{} ResultCode = integer() -CB = evaluable() +CB = evaluable()

@@ -732,12 +734,12 @@ that is somewhat unique.

Options accepted by start_service/2. -Can be any capability() tuple as +Can be any capability() tuple as well as the following.

-{application, [application_opt()]} +{application, [application_opt()]}

Defines a Diameter application supported by the service.

@@ -746,7 +748,8 @@ Defines a Diameter application supported by the service.

A service must define one application for each Diameter application it intends to support. For an outgoing Diameter request, the application is specified by -passing the desired application's application_alias() to +passing the desired application's application_alias() to call/4, while for an incoming request the application identifier in the message header determines the application (and callback module), the @@ -791,7 +794,7 @@ corresponding timeout (see transport_config below) or all fail.

 {transport_config, term()} -{transport_config, term(), Unsigned32()} +{transport_config, term(), Unsigned32()}

A term passed as the third argument to the -{applications, [application_alias()]} +{applications, [application_alias()]}

The list of Diameter applications to which usage of the transport should be restricted. Defaults to all applications configured on the service -in question.

+in question. +Must only specify applications defined on the service to which +the transport is added.

 -{capabilities, [capability()]} +{capabilities, [capability()]}

AVP's used to construct outgoing CER/CEA messages. @@ -843,7 +848,7 @@ not over SCTP as implemented by diameter_sctp(3).

 -{capabilities_cb, evaluable()} +{capabilities_cb, evaluable()}

A callback invoked upon reception of CER/CEA during capabilities @@ -871,7 +876,7 @@ case the corresponding callbacks are applied until either all return {watchdog_timer, TwInit} -TwInit = Unsigned32() +TwInit = Unsigned32() | {M,F,A} @@ -892,7 +897,7 @@ Defaults to 30000 if unspecified.

{reconnect_timer, Tc} -Tc = Unsigned32() +Tc = Unsigned32()

@@ -911,11 +916,12 @@ causing the RFC 3539 state machine to pass to state OPEN rather than REOPEN. Note that these semantics are not goverened by the RFC and that a listening transport's reconnect_timer should be greater than its -peers's Tc plus jitter.

+peer's Tc plus jitter.

Defaults to 30000 for a connecting transport and 60000 for a listening transport.

+ @@ -927,6 +933,15 @@ marker="#service_info">service_info/2 and can be referred to in predicate functions passed to remove_transport/2.

+ + + +transport_ref() = reference() + +

+An reference returned by add_transport/2 that +identifies the configuration.

 @@ -943,9 +958,9 @@ marker="#remove_transport">remove_transport/2.

-> {ok, Ref} | {error, Reason} Add transport capability to a service. -SvcName = service_name() -Options = [transport_opt()] -Ref = ref() +SvcName = service_name() +Options = [transport_opt()] +Ref = transport_ref() Reason = term() @@ -953,8 +968,8 @@ marker="#remove_transport">remove_transport/2.

Add transport capability to a service.

-The service will start a transport process(es) in order to establish a -connection with the peer, either by connecting to the peer +The service will start transport processes as required in order to +establish a connection with the peer, either by connecting to the peer (connect) or by accepting incoming connection requests (listen). A connecting transport establishes transport connections with at most @@ -990,11 +1005,11 @@ transports.

call(SvcName, App, Request, Options) -> ok | Answer | {error, Reason} Send a Diameter request message. -SvcName = service_name() -App = application_alias() -Request = diameter_app:message() | term() +SvcName = service_name() +App = application_alias() +Request = diameter_app:message() Answer = term() -Options = [call_opt()] +Options = [call_opt()]

@@ -1112,7 +1127,7 @@ transport.

-origin_state_id() -> Unsigned32() +origin_state_id() -> Unsigned32() Returns a reasonable Origin-State-Id.

@@ -1121,7 +1136,7 @@ outgoing messages.

The value returned is the number of seconds since 19680120T031408Z, -the first value that can be encoded as a Diameter Time(), +the first value that can be encoded as a Diameter Time(), at the time the diameter application was started.

@@ -1134,11 +1149,11 @@ at the time the diameter application was started.

remove_transport(SvcName, Pred) -> ok Remove previously added transports. -SvcName = service_name() -Pred = Fun | MFA | ref() | list() | true | false +SvcName = service_name() +Pred = Fun | MFA | transport_ref() | list() | true | false -Fun = fun((reference(), connect|listen, list()) -> boolean()) -    | fun((reference(), list()) -> boolean()) +Fun = fun((transport_ref(), connect|listen, list()) -> boolean()) +    | fun((transport_ref(), list()) -> boolean())     | fun((list()) -> boolean()) MFA = {atom(), atom(), list()} @@ -1156,12 +1171,12 @@ as returned by the corresponding call. The remaining forms are equivalent to an arity-3 fun as follows.

-Pred = fun(reference(), list()): fun(Ref, _, Opts) -> Pred(Ref, Opts) end -Pred = fun(list()): fun(_, _, Opts) -> Pred(Opts) end -Pred = reference(): fun(Ref, _, _) -> Pred == Ref end -Pred = list(): fun(_, _, Opts) -> [] == Pred -- Opts end -Pred = true: fun(_, _, _) -> true end -Pred = false: fun(_, _, _) -> false end +Pred = fun(transport_ref(), list()): fun(Ref, _, Opts) -> Pred(Ref, Opts) end +Pred = fun(list()): fun(_, _, Opts) -> Pred(Opts) end +Pred = transport_ref(): fun(Ref, _, _) -> Pred == Ref end +Pred = list(): fun(_, _, Opts) -> [] == Pred -- Opts end +Pred = true: fun(_, _, _) -> true end +Pred = false: fun(_, _, _) -> false end Pred = {M,F,A}: fun(Ref, Type, Opts) -> apply(M, F, [Ref, Type, Opts | A]) end @@ -1186,7 +1201,7 @@ DPA or timeout.

service_info(SvcName, Item) -> Value Return specific information about a started service. -SvcName = service_name() +SvcName = service_name() Value = term() @@ -1203,7 +1218,7 @@ Return information about a started service.

services() -> [SvcName] Return the list of started services. -SvcName = service_name() +SvcName = service_name()

@@ -1216,10 +1231,10 @@ Return the list of started services.

-session_id(Ident) -> OctetString() +session_id(Ident) -> OctetString() Return a value for a Session-Id AVP. -Ident = DiameterIdentity() +Ident = DiameterIdentity()

@@ -1244,7 +1259,7 @@ Start the diameter application.

The diameter application must be started before starting a service. -In a production system this will typically be accomplished by a boot +In a production system this is typically accomplished by a boot file, not by calling start/0 explicitly.

@@ -1256,8 +1271,8 @@ file, not by calling start/0 explicitly.

start_service(SvcName, Options) -> ok | {error, Reason} Start a Diameter service. -SvcName = service_name() -Options = [service_opt()] +SvcName = service_name() +Options = [service_opt()] Reason = term() @@ -1265,11 +1280,20 @@ file, not by calling start/0 explicitly.

Start a diameter service.

-A service defines a locally-implemented Diameter peer, specifying the -capabilities of the peer to be used during capabilities exchange and +A service defines a locally-implemented Diameter node, specifying the +capabilities of the node to be used during capabilities exchange and the Diameter applications that it supports. Transports are added to a service using add_transport/2.

+marker="#add_transport">add_transport/2. +

+ + +

+A transport can both override its service's +capabilities and restrict its supported Diameter applications so +"service = Diameter node as identified by Origin-Host" is not +necessarily the case.

+ @@ -1295,7 +1319,7 @@ Stop the diameter application.

stop_service(SvcName) -> ok | {error, Reason} Stop a Diameter service. -SvcName = service_name() +SvcName = service_name() Reason = term() @@ -1312,15 +1336,19 @@ Stop a diameter service.

subscribe(SvcName) -> true Subscribe to event messages. -SvcName = service_name() +SvcName = service_name()

-Subscribe to service_event() messages from a service.

+Subscribe to service_event() messages from +a service.

It is not an error to subscribe to events from a service -that does not yet exist.

+that does not yet exist. +Doing so before adding transports is required to guarantee the +reception of all related events.

 @@ -1332,7 +1360,7 @@ that does not yet exist.

unsubscribe(SvcName) -> true Unsubscribe to event messages. -SvcName = service_name() +SvcName = service_name()

diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml index a786443fa1..6e5c957eec 100644 --- a/lib/diameter/doc/src/diameter_app.xml +++ b/lib/diameter/doc/src/diameter_app.xml @@ -45,8 +45,8 @@ A diameter service as started by diameter:start_service/2 configures one of more Diameter applications, each of whose configuration specifies a callback that handles messages specific to -its application. -The messages and AVPs of the Diameter application are defined in a +the application. +The messages and AVPs of the application are defined in a dictionary file whose format is documented in diameter_dict(4) while the callback module is documented here. @@ -106,11 +106,13 @@ and, for the call-specific callbacks, any extra arguments passed to + + capabilities() = #diameter_caps{}

A record containing the identities of -the local and remote Diameter peers having an established transport +the local Diameter node and the remote Diameter peer having an established transport connection, as well as the capabilities as determined by capabilities exchange. Each field of the record is a 2-tuple consisting of @@ -119,6 +121,8 @@ Optional or possibly multiple values are encoded as lists of values, mandatory values as the bare value.

 + + message() = record() | list()

@@ -149,6 +153,8 @@ are sent exactly as specified.

 + + packet() = #diameter_packet{}

@@ -158,6 +164,8 @@ Fields of a packet() record should not be set in return values except as documented.

 + + peer_ref() = term()

@@ -165,12 +173,16 @@ A term identifying a transport connection with a Diameter peer. Should be treated opaquely.

 -peer() = {peer_ref(), capabilities()} + + +peer() = {peer_ref(), capabilities()}

A tuple representing a Diameter peer connection.

 + + service_name() = term()

@@ -180,6 +192,8 @@ marker="diameter#start_service">diameter:start_service/2 when starting the service.

 + + state() = term()

@@ -211,9 +225,9 @@ process.

Mod:peer_up(SvcName, Peer, State) -> NewState Invoked when a transport connection has been established -SvcName = service_name() -Peer = peer() -State = NewState = state() +SvcName = #service_name() +Peer = peer() +State = NewState = state()

@@ -230,9 +244,9 @@ the callback module in question has been configured.

Mod:peer_down(SvcName, Peer, State) -> NewState Invoked when a transport connection has been lost. -SvcName = service_name() -Peer = peer() -State = NewState = state() +SvcName = service_name() +Peer = peer() +State = NewState = state()

@@ -248,10 +262,10 @@ call to peer_up/3.

-> {ok, Peer} | {Peer, NewState} | false Select a target peer for an outgoing request. -Candidates = [peer()] -Peer = peer() | false -SvcName = service_name() -State = NewState = state() +Candidates = [peer()] +Peer = peer() | false +SvcName = service_name() +State = NewState = state()

@@ -278,7 +292,8 @@ equivalent when callback state is mutable, as are {ok, Peer} and {Peer, State}. Returning a peer as false causes {error, no_connection} to be returned from diameter:call/4. -Returning a peer() from an initial pick_peer/4 callback will result in a +Returning a peer() from an initial +pick_peer/4 callback will result in a prepare_request/3 callback followed by either handle_answer/4 @@ -301,9 +316,9 @@ received from a previously selected peer.

{Peer, NewState} and its equivalents can only be returned if the Diameter application in question was -configured with the option {call_mutates_state, true}, -as documented for diameter:start_service/2. +configured with the diameter:application_opt() +{call_mutates_state, true}. Otherwise, the State argument is always the intial value as configured on the application, not any subsequent value returned by a peer_up/3 @@ -319,10 +334,10 @@ or peer_down/3 callback.

Mod:prepare_request(Packet, SvcName, Peer) -> Action Return a request for encoding and transport. -Packet = packet() -SvcName = service_name() -Peer = peer() -Action = {send, packet() | message()} | {discard, Reason} | discard +Packet = packet() +SvcName = service_name() +Peer = peer() +Action = {send, packet() | message()} | {discard, Reason} | discard

@@ -334,13 +349,13 @@ callback need not be limited to this usage. Many implementations may simply want to return {send, Packet}

-A returned packet() should set the request to be encoded in its +A returned packet() should set the request to be encoded in its msg field and can set the transport_data field in order to pass information to the transport module. Extra arguments passed to diameter:call/4 can be used to communicate transport data to the callback. -A returned packet() can also set the header field to a +A returned packet() can also set the header field to a diameter_header record in order to specify values that should be preserved in the outgoing request, although this should typically not be necessary and allows the callback to set header values @@ -364,10 +379,10 @@ discarded}.

Mod:prepare_retransmit(Packet, SvcName, Peer) -> Result Return a request for encoding and retransmission. -Packet = packet() -SvcName = service_name() -Peer = peer() -Result = {send, packet() | message()} | {discard, Reason} | discard +Packet = packet() +SvcName = service_name() +Peer = peer() +Result = {send, packet() | message()} | {discard, Reason} | discard

@@ -375,7 +390,7 @@ Invoked to return a request for encoding and retransmission. Has the same role as prepare_request/3 in the case that a peer connection is lost an an alternate peer selected but the -argument packet() is as returned by the initial +argument packet() is as returned by the initial prepare_request/3.

@@ -394,10 +409,10 @@ discarded}.

Mod:handle_answer(Packet, Request, SvcName, Peer) -> Result Receive an answer message from a peer. -Packet = packet() -Request = message() -SvcName = service_name() -Peer = peer() +Packet = packet() +Request = message() +SvcName = service_name() +Peer = peer() Result = term() @@ -410,7 +425,7 @@ specified.

The decoded answer record is in the msg field of the argument -packet(), +packet(), the undecoded binary in the packet field. Request is the outgoing request message as was returned from prepare_request/3 or @@ -447,9 +462,9 @@ marker="diameter#start_service">diameter:start_service/2.

Return an error from a outgoing request. Reason = timeout | failover | term() -Request = message() -SvcName = service_name() -Peer = peer() +Request = message() +SvcName = service_name() +Peer = peer() Result = term() @@ -478,14 +493,14 @@ callback returned false.

Mod:handle_request(Packet, SvcName, Peer) -> Action Receive an incoming request. -Packet = packet() +Packet = packet() SvcName = term() -Peer = peer() +Peer = peer() Action = Reply | {relay, Opts} | discard | {eval, Action, PostF} -Reply = {reply, message()} +Reply = {reply, message()} | {protocol_error, 3000..3999} -Opts = diameter:call_opts() -PostF = diameter:evaluable() +Opts = diameter:call_opts() +PostF = diameter:evaluable()

@@ -501,13 +516,13 @@ itself as defining either the application in question or the Relay application.

-The argument packet() has the following signature.

+The argument packet() has the following signature.

#diameter_packet{header = #diameter_header{}, avps = [#diameter_avp{}], msg = record() | undefined, - errors = ['Unsigned32'() | {'Unsigned32'(), #diameter_avp{}}], + errors = [Unsigned32() | {Unsigned32(), #diameter_avp{}}], bin = binary(), transport_data = term()} @@ -524,8 +539,8 @@ The errors field specifies any Result-Code's identifying errors that were encountered in decoding the request. In this case diameter will set both Result-Code and Failed-AVP AVP's in a returned -answer message() before sending it to the peer: -the returned message() need only set any other required AVP's. +answer message() before sending it to the peer: +the returned message() need only set any other required AVP's. Note that the errors detected by diameter are all of the 5xxx series (Permanent Failures). The errors list is empty if the request has been received in @@ -535,7 +550,7 @@ the relay application.

The transport_data field contains an arbitrary term passed into diameter from the transport module in question, or the atom undefined if the transport specified no data. -The term is preserved in the packet() containing any answer message +The term is preserved in the packet() containing any answer message sent back to the transport process unless another value is explicitly specified.

@@ -544,7 +559,7 @@ The semantics of each of the possible return values are as follows.

-{reply, message()} +{reply, message()}

Send the specified answer message to the peer.

diff --git a/lib/diameter/doc/src/diameter_sctp.xml b/lib/diameter/doc/src/diameter_sctp.xml index c1e839b8e1..03e2f1f6be 100644 --- a/lib/diameter/doc/src/diameter_sctp.xml +++ b/lib/diameter/doc/src/diameter_sctp.xml @@ -58,11 +58,11 @@ and implements the behaviour documented in Start a transport process. Type = connect | accept -Ref = reference() +Ref = diameter:transport_ref() Svc = #diameter_service{} -Opt = {raddr, ip_address()} | {rport, integer()} | term() +Opt = {raddr, inet:ip_address()} | {rport, integer()} | term() Pid = pid() -LAddr = ip_address() +LAddr = inet:ip_address() Reason = term() diff --git a/lib/diameter/doc/src/diameter_tcp.xml b/lib/diameter/doc/src/diameter_tcp.xml index e6b53383c0..6ad98c8640 100644 --- a/lib/diameter/doc/src/diameter_tcp.xml +++ b/lib/diameter/doc/src/diameter_tcp.xml @@ -65,13 +65,13 @@ before configuring TLS capability on diameter transports.

Start a transport process. Type = connect | accept -Ref = reference() +Ref = diameter:transport_ref() Svc = #diameter_service{} Opt = OwnOpt | SslOpt | OtherOpt Pid = pid() -LAddr = ip_address() +LAddr = inet:ip_address() Reason = term() -OwnOpt = {raddr, ip_address()} +OwnOpt = {raddr, inet:ip_address()} | {rport, integer()} | {port, integer()} SslOpt = {ssl_options, true | list()} @@ -123,7 +123,7 @@ watchdog to take down the connection.

If the service specifies more than one Host-IP-Address and -option ip is unspecified then then the +option ip is unspecified then the first of the service's addresses is used as the local address.

diff --git a/lib/diameter/doc/src/diameter_transport.xml b/lib/diameter/doc/src/diameter_transport.xml index 087a90b099..4ed02e3881 100644 --- a/lib/diameter/doc/src/diameter_transport.xml +++ b/lib/diameter/doc/src/diameter_transport.xml @@ -59,11 +59,11 @@ parent).

Start a transport process. Type = connect | accept -Ref = reference() +Ref = diameter:transport_ref() Svc = #diameter_service{} Opts = term() Pid = pid() -LAddrs = [ip_address()] +LAddrs = [inet:ip_address()] Reason = term() -- cgit v1.2.3