20032009 Ericsson AB. All Rights Reserved. The contents of this file are subject to the Erlang Public License, Version 1.1, (the "License"); you may not use this file except in compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. megaco_transport Micael Karlberg Micael Karlberg Micael Karlberg 2007-06-15 %VSN% megaco_transport.xml
megaco_transport Megaco transport behaviour.

The following functions should be exported from a callback module:

send_message/2 []

send_message/3 [optional]

resend_message/2 []

 Module:send_message(Handle, Msg) -> ok | {cancel, Reason} | Error Module:send_message(Handle, Msg, Resend) -> ok | {cancel, Reason} | Error Send a megaco message. Handle = term() Msg = binary() | iolist() Resend = boolean() Reason = term() Error = term()

Send a megaco message.

If the function returns , this means the transport module decided not to send the message. This is not an error. No error messages will be issued and no error counters incremented. What actions this will result in depends on what kind of message was sent.

In the case of requests, megaco will cancel the message in much the same way as if had been called (after a successfull send). The information will be propagated back to the user differently depending on how the request(s) where issued: For requests issued using megaco:call, the info will be delivered in the return value. For requests issued using the info will be delivered via a call to the callback function handle_trans_reply.

In the case of reply, megaco will cancel the reply and information of this will be returned to the user via a call to the callback function handle_trans_ack.

The function send_message/3 will only be called if the resend_indication config option has been set to the value flag. The third argument, Resend then indicates if the message send is a resend or not.

Module:resend_message(Handle, Msg) -> ok | {cancel, Reason} | Error Re-send a megaco message. Handle = term() Msg = binary() | iolist() Reason = term() Error = term()

Re-send a megaco message.

Note that this function will only be called if the user has set the resend_indication config option to and it is in fact a message resend. If not both of these condition's are meet, will be called.

If the function returns , this means the transport module decided not to send the message. This is not an error. No error messages will be issued and no error counters incremented. What actions this will result in depends on what kind of message was sent.

In the case of requests, megaco will cancel the message in much the same way as if had been called (after a successfull send). The information will be propagated back to the user differently depending on how the request(s) where issued: For requests issued using megaco:call, the info will be delivered in the return value. For requests issued using the info will be delivered via a call to the callback function handle_trans_reply.

In the case of reply, megaco will cancel the reply and information of this will be returned to the user via a call to the callback function handle_trans_ack.