#!/usr/bin/perl -w
#
# ecaccess-gateway-name: Display the name of the default ECaccess Gateway
#
# Laurent.Gougeon@ecmwf.int - 2010-10-15

use ECMWF::ECaccess;
use Getopt::Long;
use Pod::Usage;

my %opt = ( version => 0, help => 0, manual => 0, retry => 0, debug => 0 );

pod2usage( -noperldoc => 1, -exit => 1, verbose => 1 ) if !GetOptions(
	\%opt,
	qw(
	  version
	  help|?
	  manual
	  retry=i
	  debug
	  )
);
# Display version if requested
die ECMWF::ECaccess->VERSION . "\n" if ( $opt{version} );

pod2usage( -noperldoc => 1, -exit => 1, verbose => 1 ) if ( $opt{help} );
pod2usage( -noperldoc => 1, -exit => 1, verbose => 2 ) if ( $opt{manual} );

# Create the ECaccess Controler
my $ecaccess = ECMWF::ECaccess->new( $opt{retry}, $opt{debug});

# Get the Control Channel
my $controlChannel = $ecaccess->getControlChannel();

# Display the Gateway Name
print $controlChannel->getGatewayName()->result . "\n";

__END__

=head1 NAME

ecaccess-gateway-name - Display the name of the default ECaccess Gateway

=head1 SYNOPSIS

B<ecaccess-gateway-name -version|-help|-manual>

B<ecaccess-gateway-name [-debug]>

=head1 DESCRIPTION

Display the Name of the Gateway you are connected to.

If you want to use another Gateway (e.g. a local Gateway) instead
of the default ecaccess.ecmwf.int Gateway then you can use the
following environment parameters:

  http_ecaccess=gateway.meteo.ms:9080
  https_ecaccess=gateway.meteo.ms:9443

(e.g. if your local ECaccess Gateway name is "gateway.meteo.ms" and
you are using the default ECaccess http/s ports 9080/9443)

=head1 OPTIONS

=over 8

=item B<-version>

Display version number and exits.

=item B<-help>

Print a brief help message and exits.

=item B<-manual>

Prints the manual page and exits.

=item B<-retry> I<count>

Number of SSL connection retries per 5s to ECMWF. This parameter only apply to the
initial SSL connection initiated by the command to the ECMWF server. It does not
apply to all the subsequent requests made afteward as it is mainly targeting errors
that can happen from time to time during the SSL handshake. Default is no retry.

=item B<-debug>

Display the SOAP and SSL messages exchanged.

=back

=head1 EXAMPLES

B<ecaccess-gateway-name>

Display the name of the current ECaccess Gateway.

=head1 SEE ALSO

B<ecaccess-gateway-list>, B<ecaccess-gateway-connected>, B<ecaccess>.

=cut
