PlRPC-0.2016 > RPC::PlClient

PlRPC-0.2016

名前
概要
説明
- クライアント・メソッド
使用例
作者と著作権(AUTHOR AND COPYRIGHT)
参考資料

名前¶

RPC::PlClient - PlRPCクライアントを書くためのPerl拡張

概要¶

  require RPC::PlClient;

  # クライアント・オブジェクトを作成し、サーバーに接続します
  my $client = RPC::PlClient->new('peeraddr' => 'joes.host.de',
                  'peerport' => 2570,
                  'application' => 'My App',
                  'version' => '1.0',
                  'user' => 'joe',
                  'password' => 'hello!');

  # $class->new()を呼ぶことにより、サーバーに$classのインスタンスを、
  # クライアントに対応するインスタンスを作成します。
  my $object = $client->Call('NewHandle', $class, 'new', @args);


  # $objectのメソッドを呼び出します。実際には対応するサーバー・インスタンスの
  # 同じメソッドを呼び出します。
  my $result = $object->do_method(@args);

説明¶

PlRPC (Perl RPC) はPerlベースのクライアント／サーバー・アプリケーションを書くことを簡単にするパッケージです。RPC::PlServerがサーバー側で使われるパッケージですから、RPC::PlClient は、もうお分かりのことでしょう。この部分については RPC::PlServer(3)をご覧ください。

PlRPCはクライアントにより実行されるメソッドのセットを定義することにより動きます。例えばサーバーはメソッド "multiply" をクライアントに提供するとします。そのときクライアントでの関数の呼出しは以下のようになり

    @result = $client->Call('multiply', $a, $b);

サーバーでは以下のように対応する呼出しに対応づけられます

    $server->multiply($a, $b);

数呼出しの結果ははクライアントに転送され、クライアントのメソッドの呼出しとして返されます。簡単でしょ？ :-)

クライアント・メソッド¶

$client = new(%attr);

（クラス・メソッド）クライアント・コンストラクタ。サーバーに接続されたクライアント・オブジェクトを返します。エラーの場合にはPerlの例外が投げられます。そこで典型的には以下のように使います：

    $client = eval { RPC::PlClient->new ( ... ) };
    if ($@) {
    print STDERR "Cannot create client object: $@\n";
    exit 0;
    }

The method accepts a list of key/value pairs as arguments. Known arguments are:

peeraddr

peerport

socket_proto

socket_type

timeout

これらはIO::Socket::INETのPeerAddr,PeerPort,Proto,Typeそして Timeout属性に対応します。サーバー接続はそれらをIO::Socket::INET->new()に渡すことにより確立されます。

socket

接続が確立された後、IO::Socketインスタンスはこの属性に格納されます。もし予め自分自身で接続を確立したければ、独自のIO::Socketのインスタンスを作り、 newメソッドへのsocket属性として渡すこともできます。そのような場合、上記の属性は無視されます。

application

version

user

password

これはPlRPCの認証処理の一部です。これはクライアントはアプリケーション名、プロトコル・バージョンそしてオプションでユーザ名とパスワードを渡すログイン処理に従わなければなりません。これらの引数はサーバーの Application, VersionそしてUserメソッドによって扱われます。

compression

Set this to off (default, no compression) or gzip (requires the Compress::Zlib module).

cipher

この属性は非常に簡単に暗号化を追加するために使われます。PlRPCは特定の暗号化方法ではなく、ブロック暗号化APIに結び付けられています。この属性は blocksize,encryptそして decryptメソッドをサポートしているオブジェクトになります。例えば、Crypt::DES そして Crypt::IDEAがこうしたインターフェースをサポートしています。

実行中に暗号を設定したり、はずしたりできるということに注意してください（undefを属性の値として設定すると暗号化を止めます）。しかし両側が確実に暗号のモードを変更する必要があります。

使用例:

    use Crypt::DES;
    $cipher = Crypt::DES->new(pack("H*", "0123456789abcdef"));
    $client = RPC::PlClient->new('cipher' => $cipher,
                ...);

maxmessage

サービス不能攻撃(denial of service attacks)を避けるため、クライアントとサーバーで交換されるメッセージの大きさは制限されます。デフォルトの上限は65536バイトです。

debug

デバッグのメッセージも入れることによりログ・レベルを拡張します。

logfile

デフォルトではクライアントはsyslog(Unix)またはイベント・ログ(Windows)にログを出力します。どちらかも使えないか、logfileにTRUE値を渡せば、ログは与えられたファイルハンドル、IO::Handleのインスタンスに出力されます。もし値がスカラーであれば、stderrに出力されます。

使用例:

  # stderrへログ出力:
  my $client = RPC::PlClient->new('logfile' => 1, ...);

  # 'my.log'にログ出力:
  my $file = IO::File->new('my.log', 'a')
      || die "Cannot create log file 'my.log': $!";
  my $client = RPC::PlClient->new('logfile' => $file, ...);

@result = $client->Call($method, @args);

(インスタンス・メソッド)サーバーでメソッドを呼び出します;引数はサーバー・クラスのメソッド名とメソッド呼出し引数になります。正常であれば、メソッドの結果を返します。そうでなければPerl例が投げられます。

例:

  @results = eval { $client->Call($method, @args };
  if ($@) {
      print STDERR "An error occurred while executing $method: $@\n";
      exit 0;
  }

$cobj = $client->ClientObject($class, $method, @args)

(インスタンス・メソッド)クライアント側のオブジェクトの取り扱いを驚くほど簡単にする、予め定義されたメソッドが使用できます。短く言うと、クライアントがあなたのためのサーバーオブジェクトの表現を作成します。サーバーに$sobjというオブジェクト、クライアントに対応する$cobjを持っているとします。そして以下のように呼び出します：

  @results = $cobj->my_method(@args);

これはすぐにサーバー側での以下の呼出しに対応づけられます：

  @results = $sobj->my_method(@args);

そして何もプログラムを追加することなく結果を返します。それではRPC::PlClient::Objectインスタンス、$cobjをどのように作成するのかといえば以下のようにします:

  my $cobj = $client->ClientObject($class, 'new', @args);

これはサーバーで以下の呼出しを引き起こします：

  my $sobj = $class->new(@args);

サーバーには$server->{'methods'}を適切に設定することにより、あるクラスとメソッドの両方を制限することができることに注意してください。

使用例¶

ここではMD5クライアントの例となる簡単なプログラムを作成します。サーバーにはMD5モジュールがインストールされ、ダイジェストを作成します。ここではクライアント部分だけを示します。サーバー部分の例は RPC::PlServerのmanページにあります。RPC::PlServer(3)をご覧ください。

    #!/usr/local/bin/perl

    use strict;               # 常によい選択です

    require RPC::PlClient;

    # 定数
    my $MY_APPLICATION = "MD5_Server";
    my $MY_VERSION = 1.0;
    my $MY_USER = "";       # サーバーがユーザ認証を
    my $MY_PASSWORD = "";   # 要求していません

    my $hexdigest = eval {
        my $client = RPC::PlClient->new
        ('peeraddr'    => '127.0.0.1',
         'peerport'    => 2000,
         'application' => $MY_APPLICATION,
         'version'     => $MY_VERSION,
         'user'        => $MY_USER,
         'password'    => $MY_PASSWORD);

        # サーバーにMD5オブジェクトと
        # 関連するクライアント・オブジェクトを作成します。
        #     $context = MD5->new()
        # をサーバー上で実行します。
        my $context = $client->ClientObject('MD5', 'new');

        # サーバーにダイジェストを計算させます。
        #     $context->add("This is a silly string!");
        #     $context->hexdigest();
        # をサーバーで実行します。
    $context->add("This is a silly string!");
    $context->hexdigest();
    };
    if ($@) {
        die "An error occurred: $@";
    }

    print "Got digest $hexdigest\n";

作者と著作権(AUTHOR AND COPYRIGHT)¶

The PlRPC-modules are

  Copyright (C) 1998, Jochen Wiedmann
                      Am Eisteich 9
                      72555 Metzingen
                      Germany

                      Phone: +49 7123 14887
                      Email: [email protected]

  All rights reserved.

You may distribute this package under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file.

参考資料¶

PlRPC::Server(3), Net::Daemon(3), Storable(3), Sys::Syslog(3), Win32::EventLog

アプリケーションの例としてはDBI Proxyクライアントがあります:

DBD::Proxy(3).