<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/erlang/osmo_ss7/+/19806">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
laforge: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">ipa_proto: Add notion of 'codecs'<br><br>A codec for a given Stream Identifier can be registered with encode<br>and decode functions. This codec transcodes from the binary payload<br>of messages within that stream identifier and some abstract<br>representation. Any received messages will be passed through decode,<br>while any to-be-transmitted messages will be passed through encode.<br><br>Change-Id: I8eaf888402545a1a871df9ae3dfbce690729dd03<br>---<br>M src/ipa_proto.erl<br>1 file changed, 44 insertions(+), 13 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/ipa_proto.erl b/src/ipa_proto.erl</span><br><span>index c191a74..9a3f3d0 100644</span><br><span>--- a/src/ipa_proto.erl</span><br><span>+++ b/src/ipa_proto.erl</span><br><span>@@ -37,11 +37,16 @@</span><br><span> </span><br><span> -export([register_socket/1, register_stream/3, unregister_stream/2,</span><br><span> send/3, connect/3, connect/4, listen_accept_handle/2,</span><br><span style="color: hsl(0, 100%, 40%);">- start_listen/3, controlling_process/3]).</span><br><span style="color: hsl(120, 100%, 40%);">+ start_listen/3, controlling_process/3, register_codec/3]).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+-type stream_id() :: integer() | {osmo, integer()}.</span><br><span> </span><br><span> -record(ipa_socket, {socket, ipaPid, streamTbl, listenType}).</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+-record(ipa_codec, {streamId :: stream_id(),</span><br><span style="color: hsl(120, 100%, 40%);">+ encodeFn :: fun(),</span><br><span style="color: hsl(120, 100%, 40%);">+ decodeFn :: fun()</span><br><span style="color: hsl(120, 100%, 40%);">+ }).</span><br><span> </span><br><span> % register a TCP socket with this IPA protocol implementation</span><br><span> register_socket(Socket) -></span><br><span>@@ -124,15 +129,43 @@</span><br><span> </span><br><span> % deliver an incoming message to the process that is registered for the socket/stream_id</span><br><span> deliver_rx_ipa_msg(Socket, StreamID, StreamMap, DataBin) -></span><br><span style="color: hsl(120, 100%, 40%);">+ DataDec = try_decode(StreamID, DataBin),</span><br><span> case ets:lookup(StreamMap, {Socket, StreamID}) of</span><br><span> [{_,{process_id, Pid}}] -></span><br><span style="color: hsl(0, 100%, 40%);">- Pid ! {ipa, Socket, StreamID, DataBin};</span><br><span style="color: hsl(120, 100%, 40%);">+ Pid ! {ipa, Socket, StreamID, DataDec};</span><br><span> [{_,{callback_fn, Fn, Args}}] -></span><br><span style="color: hsl(0, 100%, 40%);">- Fn(Socket, StreamID, DataBin, Args);</span><br><span style="color: hsl(120, 100%, 40%);">+ Fn(Socket, StreamID, DataDec, Args);</span><br><span> [] -></span><br><span> io:format("No Pid registered for Socket ~p Stream ~p~n", [Socket, StreamID])</span><br><span> end.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+% register a Codec with this IPA protocol implementation</span><br><span style="color: hsl(120, 100%, 40%);">+-spec register_codec(stream_id(), fun(), fun()) -> boolean().</span><br><span style="color: hsl(120, 100%, 40%);">+register_codec(StreamID, EncodeFn, DecodeFn) -></span><br><span style="color: hsl(120, 100%, 40%);">+ ets:insert(ipa_codecs, #ipa_codec{streamId=StreamID, encodeFn=EncodeFn, decodeFn=DecodeFn}).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+-spec try_decode(stream_id(), binary()) -> any().</span><br><span style="color: hsl(120, 100%, 40%);">+try_decode(StreamID, Data) -></span><br><span style="color: hsl(120, 100%, 40%);">+ case ets:lookup(ipa_codecs, StreamID) of</span><br><span style="color: hsl(120, 100%, 40%);">+ [IpaCodec] -></span><br><span style="color: hsl(120, 100%, 40%);">+ Fun = IpaCodec#ipa_codec.decodeFn,</span><br><span style="color: hsl(120, 100%, 40%);">+ Fun(Data);</span><br><span style="color: hsl(120, 100%, 40%);">+ [] -></span><br><span style="color: hsl(120, 100%, 40%);">+ Data</span><br><span style="color: hsl(120, 100%, 40%);">+ end.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+-spec try_encode(stream_id(), any()) -> binary().</span><br><span style="color: hsl(120, 100%, 40%);">+try_encode(_StreamID, Data) when is_binary(Data) -></span><br><span style="color: hsl(120, 100%, 40%);">+ Data;</span><br><span style="color: hsl(120, 100%, 40%);">+try_encode(StreamID, Data) -></span><br><span style="color: hsl(120, 100%, 40%);">+ case ets:lookup(ipa_codecs, StreamID) of</span><br><span style="color: hsl(120, 100%, 40%);">+ [IpaCodec] -></span><br><span style="color: hsl(120, 100%, 40%);">+ Fun = IpaCodec#ipa_codec.encodeFn,</span><br><span style="color: hsl(120, 100%, 40%);">+ Fun(Data);</span><br><span style="color: hsl(120, 100%, 40%);">+ [] -></span><br><span style="color: hsl(120, 100%, 40%);">+ Data</span><br><span style="color: hsl(120, 100%, 40%);">+ end.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> % process (split + deliver) an incoming IPA message</span><br><span> process_rx_ipa_msg(_S, _StreamMap, <<>>) -></span><br><span> ok;</span><br><span>@@ -173,10 +206,12 @@</span><br><span> </span><br><span> % send a binary message through a given Socket / StreamID</span><br><span> send(Socket, {osmo, StreamIdExt}, DataBin) -></span><br><span style="color: hsl(0, 100%, 40%);">- send(Socket, ?IPAC_PROTO_OSMO, [StreamIdExt, DataBin]);</span><br><span style="color: hsl(120, 100%, 40%);">+ DataEnc = try_encode({osmo, StreamIdExt}, DataBin),</span><br><span style="color: hsl(120, 100%, 40%);">+ send(Socket, ?IPAC_PROTO_OSMO, [StreamIdExt, DataEnc]);</span><br><span> send(Socket, StreamID, DataBin) -></span><br><span style="color: hsl(0, 100%, 40%);">- Size = iolist_size(DataBin),</span><br><span style="color: hsl(0, 100%, 40%);">- gen_tcp:send(Socket, iolist_to_binary([<<Size:2/big-unsigned-integer-unit:8>>, StreamID, DataBin])).</span><br><span style="color: hsl(120, 100%, 40%);">+ DataEnc = try_encode(StreamID, DataBin),</span><br><span style="color: hsl(120, 100%, 40%);">+ Size = iolist_size(DataEnc),</span><br><span style="color: hsl(120, 100%, 40%);">+ gen_tcp:send(Socket, iolist_to_binary([<<Size:2/big-unsigned-integer-unit:8>>, StreamID, DataEnc])).</span><br><span> </span><br><span> </span><br><span> call_sync(Pid, Request) -></span><br><span>@@ -194,12 +229,8 @@</span><br><span> </span><br><span> % global module initialization</span><br><span> init() -></span><br><span style="color: hsl(0, 100%, 40%);">- case ets:new(ipa_sockets, [named_table, set, public, {keypos, #ipa_socket.socket}]) of</span><br><span style="color: hsl(0, 100%, 40%);">- ipa_sockets -></span><br><span style="color: hsl(0, 100%, 40%);">- ok;</span><br><span style="color: hsl(0, 100%, 40%);">- _ -></span><br><span style="color: hsl(0, 100%, 40%);">- {error, ets_new_ipa_sockets}</span><br><span style="color: hsl(0, 100%, 40%);">- end.</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_sockets = ets:new(ipa_sockets, [named_table, set, public, {keypos, #ipa_socket.socket}]),</span><br><span style="color: hsl(120, 100%, 40%);">+ ipa_codecs = ets:new(ipa_codecs, [named_table, set, public, {keypos, #ipa_codec.streamId}]).</span><br><span> </span><br><span> % initialize a signle socket, create its handle process</span><br><span> init_sock(Socket, CallingPid) -></span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/erlang/osmo_ss7/+/19806">change 19806</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/erlang/osmo_ss7/+/19806"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: erlang/osmo_ss7 </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I8eaf888402545a1a871df9ae3dfbce690729dd03 </div>
<div style="display:none"> Gerrit-Change-Number: 19806 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>