#
# Copyright (c) 2001-2012 NetApp, Inc., All Rights Reserved
#   Any use, modification, or distribution is prohibited
#   without prior written consent from NetApp, Inc.
#

## @summary DebugCsmSession ComponentState Module (auto-generated by CGT)
## @author dl-nacl-dev@netapp.com
## @status shared
## @pod here

=head1 NAME

NACL::CS::DebugCsmSession

=head1 DESCRIPTION

C<NACL::CS::DebugCsmSession> is a derived class of
L<NACL::CS::ComponentState::ONTAP|lib-NACL-CS-ComponentState-ONTAP-pm>. It represents the
state of an ONTAP DebugCsmSession.  A related class is
L<NACL::C::DebugCsmSession|lib-NACL-C-DebugCsmSession-pm>, which represents access
to an ONTAP DebugCsmSession.

=head1 ATTRIBUTES

The individual pieces of data that are part of the state of the DebugCsmSession
element are the attributes of the DebugCsmSession ComponentState.

=over

=item C<< application_req_rcvd >>

Filled in for CMode CLI.

=item C<< resp_rcvd >>

Filled in for CMode CLI.

=item C<< target >>

Filled in for CMode CLI.

=item C<< backpressure >>

Filled in for CMode CLI.

=item C<< deferred_queue_insert >>

Filled in for CMode CLI.

=item C<< use_qos >>

Filled in for CMode CLI.

=item C<< timeout >>

Filled in for CMode CLI.

=item C<< resp_bytes_rcvd >>

Filled in for CMode CLI.

=item C<< rto >>

Filled in for CMode CLI.

=item C<< rto_med >>

Filled in for CMode CLI.

=item C<< resp_sent >>

Filled in for CMode CLI.

=item C<< channels_hiwat_low >>

Filled in for CMode CLI.

=item C<< session_agg_bw >>

Filled in for CMode CLI.

=item C<< time_of_bw_check >>

Filled in for CMode CLI.

=item C<< max_window_med >>

Filled in for CMode CLI.

=item C<< cur_window_med >>

Filled in for CMode CLI.

=item C<< bw_backoff_set_count >>

Filled in for CMode CLI.

=item C<< disable_congestion_control >>

Filled in for CMode CLI.

=item C<< uniquifier >>

Filled in for CMode CLI.

=item C<< deferred_queue_drain >>

Filled in for CMode CLI.

=item C<< cur_window_low >>

Filled in for CMode CLI.

=item C<< channels_hiwat_med >>

Filled in for CMode CLI.

=item C<< node >>

Filled in for CMode CLI.

=item C<< bw_average >>

Filled in for CMode CLI.

=item C<< bw_backoff_clear_count >>

Filled in for CMode CLI.

=item C<< rsp_pending >>

Filled in for CMode CLI.

=item C<< channels_inuse >>

Filled in for CMode CLI.

=item C<< rto_low >>

Filled in for CMode CLI.

=item C<< bw_limit >>

Filled in for CMode CLI.

=item C<< cur_window >>

Filled in for CMode CLI.

=item C<< rto_high >>

Filled in for CMode CLI.

=item C<< channels_hiwat_high >>

Filled in for CMode CLI.

=item C<< session_agg_bytes_sent >>

Filled in for CMode CLI.

=item C<< req_pending >>

Filled in for CMode CLI.

=item C<< deferred_queue_discard >>

Filled in for CMode CLI.

=item C<< max_window_high >>

Filled in for CMode CLI.

=item C<< bw_checks >>

Filled in for CMode CLI.

=item C<< timedout_resp >>

Filled in for CMode CLI.

=item C<< requests_high >>

Filled in for CMode CLI.

=item C<< req_bytes_sent >>

Filled in for CMode CLI.

=item C<< state >>

Filled in for CMode CLI.

=item C<< rsp_bytes_sent >>

Filled in for CMode CLI.

=item C<< requests_med >>

Filled in for CMode CLI.

=item C<< uptime >>

Filled in for CMode CLI.

=item C<< session_timeout_count >>

Filled in for CMode CLI.

=item C<< bw_backoff >>

Filled in for CMode CLI.

=item C<< target_string >>

Filled in for CMode CLI.

=item C<< req_rcvd >>

Filled in for CMode CLI.

=item C<< max_window >>

Filled in for CMode CLI.

=item C<< canceled_requests >>

Filled in for CMode CLI.

=item C<< bytes_sent_since_bw_check >>

Filled in for CMode CLI.

=item C<< application_req_callbacks >>

Filled in for CMode CLI.

=item C<< pointer >>

Filled in for CMode CLI.

=item C<< req_bytes_rcvd >>

Filled in for CMode CLI.

=item C<< cur_window_high >>

Filled in for CMode CLI.

=item C<< type >>

Filled in for CMode CLI.

=item C<< requests_low >>

Filled in for CMode CLI.

=item C<< bw_send_count >>

Filled in for CMode CLI.

=item C<< req_sent >>

Filled in for CMode CLI.

=item C<< initiator_string >>

Filled in for CMode CLI.

=item C<< application_req_sent >>

Filled in for CMode CLI.

=item C<< requests >>

Filled in for CMode CLI.

=item C<< max_window_low >>

Filled in for CMode CLI.

=item C<< initiator >>

Filled in for CMode CLI.

=item C<< response_snd_queue_insert >>

No. of Send Queue Inserts

Filled in for CMode CLI.

=item C<< total_conn >>

Total Connections across All Priorities

Filled in for CMode CLI.

=item C<< response_snd_queue_discard >>

No. of Send Queue Discards

Filled in for CMode CLI.

=item C<< response_snd_queue_drain >>

No. of Send Queue Drains

Filled in for CMode CLI.

=item C<< request_snd_queue_hiwat_med >>

Hiwat value for Send Queue for medium prio req

Filled in for CMode CLI.

=item C<< request_snd_queue_hiwat_high >>

Hiwat value for Send Queue for high prio req

Filled in for CMode CLI.

=item C<< response_snd_queue_hiwat_high >>

Hiwat value for Send Queue for high prio resp

Filled in for CMode CLI.

=item C<< request_snd_queue_discard >>

No. of Send Queue Discards

Filled in for CMode CLI.

=item C<< response_snd_queue_hiwat_med >>

Hiwat value for Send Queue for medium prio resp

Filled in for CMode CLI.

=item C<< rtt_total_time >>

Total Round-trip Time

Filled in for CMode CLI.

=item C<< request_snd_queue_drain >>

No. of Send Queue Drains

Filled in for CMode CLI.

=item C<< request_snd_queue_insert >>

No. of Send Queue Inserts

Filled in for CMode CLI.

=item C<< request_snd_queue_hiwat_low >>

Hiwat value for Send Queue for low prio req

Filled in for CMode CLI.

=item C<< response_snd_queue_hiwat_low >>

Hiwat value for Send Queue for low prio resp

Filled in for CMode CLI.


=item C<< authenticated >>

Whether the Session is Authenticated possible value(s) are, true,false

Filled in for CMode CLI.

=item C<< cluster >>

Remote Cluster

Filled in for CMode CLI.


=item C<< requests_hiwat_low >>

High Water Mark for Low Priority Channels in Use

Filled in for CMode CLI.

=item C<< requests_hiwat_med >>

High Water Mark for Medium Priority Channels in Use

Filled in for CMode CLI.

=item C<< requests_hiwat_high >>

High Water Mark for High Priority Channels in Use

Filled in for CMode CLI.


=item C<< enable_local_timeout_return_code >>

CSM_TIMEOUT_LOCAL enabled possible value(s) are, true,false

Filled in for CMode CLI.

=item C<< total_deferred_timeout >>

No. of local timeouts

Filled in for CMode CLI.


=item C<< can_sess_retransmit_be_disabled >>


Can Session Layer Retransmit be Disabled Per Request possible value(s) are, true,false

Filled in for CMode CLI.

=item C<< sess_retransmit_wait_period_ms >>

Milliseconds to Wait for a Response After Connection Failure

Filled in for CMode CLI.

=item C<< timedout_before_no_retransmit_timeout >>

No. of No Retransmit Requests Timed Out While Waiting for a Response

Filled in for CMode CLI.

=item C<< requests_not_retransmitted >>

No. of Requests Not Retransmitted After Connection Failure

Filled in for CMode CLI.

=item C<< calledback_after_no_retransmit_timeout >>

No. of No Retransmit Requests Calledback After Waiting for a Response

Filled in for CMode CLI.

=item C<< canceled_before_no_retransmit_timeout >>

No. of No Retransmit Requests Canceled While Waiting for a Response

Filled in for CMode CLI.

=item C<< position >>

Pointer Position

Filled in for CMode CLI.

=item C<< response_before_no_retransmit_timeout >>

No. of No Retransmit Requests that Recieved a Response

Filled in for CMode CLI.


=back

=cut

package NACL::CS::DebugCsmSession;

use strict;
use warnings;
use Params::Validate qw(validate);
use NACL::ComponentUtils qw(_dump_one);
use NATE::Log qw(log_global);
my $Log = log_global();
my $may_enter = $Log->may_enter();
my $may_exit  = $Log->may_exit();
use Data::Dumper;

use NACL::Exceptions::NoElementsFound qw(:try);

use base 'NACL::CS::ComponentState::ONTAP';

use Class::MethodMaker [
    scalar => 'application_req_rcvd',
    scalar => 'resp_rcvd',
    scalar => 'target',
    scalar => 'backpressure',
    scalar => 'deferred_queue_insert',
    scalar => 'use_qos',
    scalar => 'timeout',
    scalar => 'resp_bytes_rcvd',
    scalar => 'rto',
    scalar => 'rto_med',
    scalar => 'resp_sent',
    scalar => 'channels_hiwat_low',
    scalar => 'session_agg_bw',
    scalar => 'time_of_bw_check',
    scalar => 'max_window_med',
    scalar => 'cur_window_med',
    scalar => 'bw_backoff_set_count',
    scalar => 'disable_congestion_control',
    scalar => 'uniquifier',
    scalar => 'deferred_queue_drain',
    scalar => 'cur_window_low',
    scalar => 'channels_hiwat_med',
    scalar => 'node',
    scalar => 'bw_average',
    scalar => 'bw_backoff_clear_count',
    scalar => 'rsp_pending',
    scalar => 'channels_inuse',
    scalar => 'rto_low',
    scalar => 'bw_limit',
    scalar => 'cur_window',
    scalar => 'rto_high',
    scalar => 'channels_hiwat_high',
    scalar => 'session_agg_bytes_sent',
    scalar => 'req_pending',
    scalar => 'deferred_queue_discard',
    scalar => 'max_window_high',
    scalar => 'bw_checks',
    scalar => 'timedout_resp',
    scalar => 'requests_high',
    scalar => 'req_bytes_sent',
    scalar => 'state',
    scalar => 'rsp_bytes_sent',
    scalar => 'requests_med',
    scalar => 'uptime',
    scalar => 'session_timeout_count',
    scalar => 'bw_backoff',
    scalar => 'target_string',
    scalar => 'req_rcvd',
    scalar => 'max_window',
    scalar => 'canceled_requests',
    scalar => 'bytes_sent_since_bw_check',
    scalar => 'application_req_callbacks',
    scalar => 'pointer',
    scalar => 'req_bytes_rcvd',
    scalar => 'cur_window_high',
    scalar => 'type',
    scalar => 'requests_low',
    scalar => 'bw_send_count',
    scalar => 'req_sent',
    scalar => 'initiator_string',
    scalar => 'application_req_sent',
    scalar => 'requests',
    scalar => 'max_window_low',
    scalar => 'initiator',
    scalar => 'response_snd_queue_insert',
    scalar => 'total_conn',
    scalar => 'response_snd_queue_discard',
    scalar => 'response_snd_queue_drain',
    scalar => 'request_snd_queue_hiwat_med',
    scalar => 'request_snd_queue_hiwat_high',
    scalar => 'response_snd_queue_hiwat_high',
    scalar => 'request_snd_queue_discard',
    scalar => 'response_snd_queue_hiwat_med',
    scalar => 'rtt_total_time',
    scalar => 'request_snd_queue_drain',
    scalar => 'request_snd_queue_insert',
    scalar => 'request_snd_queue_hiwat_low',
    scalar => 'response_snd_queue_hiwat_low',
    scalar => 'authenticated',
    scalar => 'cluster',
    scalar => 'requests_hiwat_low',
    scalar => 'requests_hiwat_med',
    scalar => 'requests_hiwat_high',
    scalar => 'enable_local_timeout_return_code',
    scalar => 'total_deferred_timeout',
    scalar => 'can_sess_retransmit_be_disabled',
    scalar => 'sess_retransmit_wait_period_ms',
    scalar => 'timedout_before_no_retransmit_timeout',
    scalar => 'requests_not_retransmitted',
    scalar => 'calledback_after_no_retransmit_timeout',
    scalar => 'canceled_before_no_retransmit_timeout',
    scalar => 'position',
    scalar => 'response_before_no_retransmit_timeout',
];

=head1 METHODS

=head2 fetch

    my $DebugCsmSession_state   = NACL::CS::DebugCsmSession->fetch(command_interface => $ci, ...);
	my @DebugCsmSession_states = NACL::CS::DebugCsmSession->fetch(command_interface => $ci, ...);

(Class method)
Discovers which elements are present and returns their state in ComponentState
objects. Called in scalar context it returns only one state object, in list
context it returns all state objects.
See L<NACL::CS::ComponentState|lib-NACL-CS-ComponentState-pm/fetch> for a
more detailed description along with a complete explanation of the options
it accepts.

Supports CMode CLI.

=over

=item Exceptions

=over

=item C<NACL::Exceptions::NoElementsFound>

When there are no elements matching the query specified or elements of that type
doesn't exist, then this exception will be thrown.

=back

=back

=cut

sub fetch {
    $Log->enter() if $may_enter;
    my $pkg        = shift;
    my @state_objs = $pkg->SUPER::fetch(
        @_,
	show_cmd => 'debug csm session show',
	choices => [
            {   method    => '_fetch_cmode_cli',
                interface => 'CLI',
                set       => 'CMode',
            },
        ],
        exception_text => 'No matching debug csm session(s) found'
    );

    $Log->exit() if $may_exit;
    return wantarray ? @state_objs : $state_objs[0];
} ## end sub fetch

sub _fetch_cmode_cli {
    $Log->enter() if $may_enter;
    my $pkg = shift;
    my @state_objs
        = $pkg->SUPER::_fetch_cmode_cli(@_, api => 'debug_csm_session_show');
    $Log->exit() if $may_exit;
    return @state_objs;
} ## end sub _fetch_cmode_cli

1;