1 files changed, 79 insertions, 0 deletions
diff --git a/lib/snmp/src/agent/snmpa_get_mechanism.erl b/lib/snmp/src/agent/snmpa_get_mechanism.erl
new file mode 100644
index 0000000000..744a6529e1
--- /dev/null
+++ b/lib/snmp/src/agent/snmpa_get_mechanism.erl
@@ -0,0 +1,79 @@
+%%
+%% %CopyrightBegin%
+%%
+%% Copyright Ericsson AB 2019-2019. All Rights Reserved.
+%%
+%% Licensed under the Apache License, Version 2.0 (the "License");
+%% you may not use this file except in compliance with the License.
+%% You may obtain a copy of the License at
+%%
+%%     http://www.apache.org/licenses/LICENSE-2.0
+%%
+%% Unless required by applicable law or agreed to in writing, software
+%% distributed under the License is distributed on an "AS IS" BASIS,
+%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+%% See the License for the specific language governing permissions and
+%% limitations under the License.
+%%
+%% %CopyrightEnd%
+%%
+
+-module(snmpa_get_mechanism).
+
+%%
+%% This module defines the behaviour for the undocumented (hidden)
+%% get-mechanism feature. This allows for implementing your own
+%% handling of get, get-next and get-bulk requests.
+%% Probably only useful for special cases (e.g. optimization).
+%%
+
+
+
+%% ----------- do_get/2,3 -----------------------------------------------------
+
+%% Purpose: Handles all VBs in a request that is inside the 
+%%          mibview (local).
+
+-callback do_get(UnsortedVBs    :: [snmp:varbind()],
+                 IsNotification :: boolean(),
+                 Extra          :: term()) ->
+    {noError, 0, ResVBs :: [snmp:varbind()]} |
+    {ErrStatus :: snmp:error_status(), ErrIndex :: snmp:error_index(), []}.
+
+
+%% Purpose: Handles "get-requests".
+
+-callback do_get(MibView        :: snmp_view_based_acm_mib:mibview(), 
+                 UnsortedVBs    :: [snmp:varbind()],
+                 IsNotification :: boolean(),
+                 Extra          :: term()) ->
+    {noError, 0, ResVBs :: [snmp:varbind()]} |
+    {ErrStatus :: snmp:error_status(), ErrIndex :: snmp:error_index(), []}.
+
+
+
+
+%% ----------- do_get_next/2 ------------------------------------------------
+
+%% Purpose: Handles "get-next-requests".
+
+-callback do_get_next(MibView     :: snmp_view_based_acm_mib:mibview(),
+                      UnsortedVBs :: [snmp:varbind()],
+                      Extra       :: term()) ->
+    {noError, 0, ResVBs :: [snmp:varbind()]} |
+    {ErrStatus :: snmp:error_status(), ErrIndex :: snmp:error_index(), []}.
+
+
+
+
+%% ----------- do_get_bulk/6 ------------------------------------------------
+
+-callback do_get_bulk(MibView        :: snmp_view_based_acm_mib:mibview(),
+                      NonRepeaters   :: non_neg_integer(),
+                      MaxRepetitions :: non_neg_integer(),
+                      PduMS          :: pos_integer(),
+                      VBs            :: [snmp:varbind()],
+                      MaxVBs         :: pos_integer(),
+                      Extra          :: term()) ->
+    {noError, 0, ResVBs :: [snmp:varbind()]} |
+    {ErrStatus :: snmp:error_status(), ErrIndex :: snmp:error_index(), []}.