The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

JDEGUEST / HTTP-Promise-v0.5.3 / lib / HTTP / Promise / Headers / ServerTiming.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
—
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178

              
##----------------------------------------------------------------------------
## Asynchronous HTTP Request and Promise - ~/lib/HTTP/Promise/Headers/ServerTiming.pm
## Version v0.1.0
## Copyright(c) 2022 DEGUEST Pte. Ltd.
## Author: Jacques Deguest <jack@deguest.jp>
## Created 2022/05/08
## Modified 2022/05/08
## All rights reserved.
## 
## 
## This program is free software; you can redistribute  it  and/or  modify  it
## under the same terms as Perl itself.
##----------------------------------------------------------------------------
package HTTP::Promise::Headers::ServerTiming;
BEGIN
{
    use strict;
    use warnings;
    use warnings::register;
    use parent qw( HTTP::Promise::Headers::Generic );
    our $VERSION = 'v0.1.0';
};
use strict;
use warnings;
sub init
{
    my $self = shift( @_ );
    @_ = () if( @_ == 1 && $self->_is_a( $_[0] => 'Module::Generic::Null' ) );
    if( @_ )
    {
        my $this = shift( @_ );
        my $hv;
        if( index( $this, ';' ) != -1 )
        {
            $hv = $self->_parse_header_value( $this );
        }
        else
        {
            $hv = $self->_new_hv( $this );
        }
        return( $self->pass_error ) if( !defined( $hv ) );
        my $opts = $self->_get_args_as_hash( @_ );
        $hv->param( $_ => $opts->{ $_ } ) for( keys( %$opts ) );
        $self->_hv( $hv );
    }
    $self->{_init_strict_use_sub} = 1;
    $self->SUPER::init( @_ ) || return( $self->pass_error );
    $self->_field_name( 'Server-Timing' );
    return( $self );
}
sub as_string { return( shift->_hv_as_string( @_ ) ); }
sub desc { return( shift->_set_get_param( 'desc', @_ ) ); }
sub dur { return( shift->_set_get_param( 'dur', @_ ) ); }
sub name
{
    my $self = shift( @_ );
    my $hv = $self->_hv;
    if( @_ )
    {
        my $this = shift( @_ );
        if( $hv )
        {
            $hv->value( $this );
        }
        else
        {
            $hv = $self->_new_hv( $this );
            $self->_hv( $hv );
        }
        return( $this);
    }
    else
    {
        return( '' ) if( !$hv );
        return( $hv->value_data );
    }
}
sub param { return( shift->_set_get_param( @_ ) ); }
sub params { return( shift->_set_get_params( @_ ) ); }
1;
# NOTE: POD
__END__
=encoding utf-8
=head1 NAME
HTTP::Promise::Headers::ServerTiming - Server-Timing Header Field
=head1 SYNOPSIS
    use HTTP::Promise::Headers::ServerTiming;
    my $srv = HTTP::Promise::Headers::ServerTiming->new || 
        die( HTTP::Promise::Headers::ServerTiming->error, "\n" );
    $srv->name( 'cache' );
    $srv->dur(2.4);
    $srv->desc( 'Cache Read' );
=head1 VERSION
    v0.1.0
=head1 DESCRIPTION
The following is an extract from Mozilla documentation.
The Server-Timing header communicates one or more metrics and descriptions for a given request-response cycle.
Example:
    # Single metric without value
    Server-Timing: missedCache
    # Single metric with value
    Server-Timing: cpu;dur=2.4
    # Single metric with description and value
    Server-Timing: cache;desc="Cache Read";dur=23.2
    # Two metrics with value
    Server-Timing: db;dur=53, app;dur=47.2
=head1 METHODS
=head2 as_string
Returns a string representation of the C<Server-Timing> object.
=head2 desc
Sets or gets the server timing description.
=head2 dur
Sets or gets the duration
=head2 name
Sets or gets the server timing metrics name.
=head2 param
Set or get an arbitrary name-value pair attribute.
=head2 params
Set or get multiple name-value parameters.
Calling this without any parameters, retrieves the associated L<hash object|Module::Generic::Hash>
=head1 AUTHOR
Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
=head1 SEE ALSO
L<Mozilla documentation|https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Server-Timing>
L<HTTP::Promise>, L<HTTP::Promise::Request>, L<HTTP::Promise::Response>, L<HTTP::Promise::Message>, L<HTTP::Promise::Entity>, L<HTTP::Promise::Headers>, L<HTTP::Promise::Body>, L<HTTP::Promise::Body::Form>, L<HTTP::Promise::Body::Form::Data>, L<HTTP::Promise::Body::Form::Field>, L<HTTP::Promise::Status>, L<HTTP::Promise::MIME>, L<HTTP::Promise::Parser>, L<HTTP::Promise::IO>, L<HTTP::Promise::Stream>, L<HTTP::Promise::Exception>
=head1 COPYRIGHT & LICENSE
Copyright(c) 2022 DEGUEST Pte. Ltd.
All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
=cut