名前¶

LWP::ConnCache - 接続キャッシュマネージャ

NOTE¶

このモジュールは実験的なものです。 インターフェースの詳細は、将来変更される可能性があります。

概要¶

 use LWP::ConnCache;
 my $cache = LWP::ConnCache->new;
 $cache->deposit($type, $key, $sock);
 $sock = $cache->withdraw($type, $key);

説明¶

LWP::ConnCache クラスは、LWP::UserAgent 用の 標準接続キャッシュマネージャーです。

次の基本的なメソッドが提供されています:

$cache = LWP::ConnCache->new( %options )

This method constructs a new LWP::ConnCache object. The only option currently accepted is 'total_capacity'. If specified it initialize the total_capacity option. It defaults to the value 1.

このメソッドは、新しい LWP::ConnCache オブジェクトを構築します。 現在使用できるオプションは 'total_capacity' のみです。 指定した場合、total_capacity オプションが初期化されます。 デフォルト値は 1 です。

$cache->total_capacity( [$num_connections] )

Get/sets the number of connection that will be cached. Connections will start to be dropped when this limit is reached. If set to 0, then all connections are immediately dropped. If set to undef, then there is no limit.

キャッシュされる接続の数を取得/設定します。 この制限に達すると、接続の破棄が始まります。 0 に設定すると、すべての接続がすぐに破棄されます。 undef に設定すると、制限はありません。

$cache->capacity($type, [$num_connections] )

Get/set a limit for the number of connections of the specified type that can be cached. The $type will typically be a short string like "http" or "ftp".

指定された型のキャッシュ可能な接続数の制限を取得/設定します。 $type は通常、「http」や「ftp」などの短い文字列です。

$cache->drop( [$checker, [$reason]] )

Drop connections by some criteria. The $checker argument is a subroutine that is called for each connection. If the routine returns a TRUE value then the connection is dropped. The routine is called with ($conn, $type, $key, $deposit_time) as arguments.

何らかの基準で接続を切断します。 $checker 引数は、接続ごとに呼び出されるサブルーチンです。 このルーチンが真の値を返すと、接続が切断されます。 このルーチンは、($conn, $type, $key, $deposit_time) を引数として 呼び出されます。

Shortcuts: If the $checker argument is absent (or undef) all cached connections are dropped. If the $checker is a number then all connections untouched that the given number of seconds or more are dropped. If $checker is a string then all connections of the given type are dropped.

ショートカット: $checker 引数がない(または undef)場合は、 キャッシュされた全ての接続が破棄されます。 $checker が数値の場合は、指定された秒数以上触れられていない全ての接続が 破棄されます。 $checker が文字列の場合は、指定された型の全ての接続が破棄されます。

The $reason argument is passed on to the dropped() method.

$reason 引数は、dropped() メソッドに渡されます。

$cache->prune

Calling this method will drop all connections that are dead. This is tested by calling the ping() method on the connections. If the ping() method exists and returns a FALSE value, then the connection is dropped.

このメソッドを呼び出すと、停止している全ての接続が破棄されます。 これは、接続に対して ping() メソッドを呼び出すことによってテストされます。 ping() メソッドが存在し、偽の値を戻す場合、接続は破棄されます。

$cache->get_types

This returns all the 'type' fields used for the currently cached connections.

現在キャッシュされている接続に使われている全ての「type」フィールドを返します。

$cache->get_connections( [$type] )

This returns all connection objects of the specified type. If no type is specified then all connections are returned. In scalar context the number of cached connections of the specified type is returned.

指定された型の全ての接続オブジェクトを返します。 型が指定されていない場合は、全ての接続が戻されます。 スカラコンテキストでは、指定された型のキャッシュされた接続の数が返されます。

次のメソッドは、低レベルのプロトコルモジュールによって呼び出され、 接続を保存して元に戻そうとします。

$cache->deposit($type, $key, $conn)

This method adds a new connection to the cache. As a result other already cached connections might be dropped. Multiple connections with the same $type/$key might added.

このメソッドは、新しい接続をキャッシュに追加します。 その結果、すでにキャッシュされている他の接続が削除される可能性があります。 同じ $type/$key を持つ複数の接続が追加される可能性があります。

$conn = $cache->withdraw($type, $key)

This method tries to fetch back a connection that was previously deposited. If no cached connection with the specified $type/$key is found, then undef is returned. There is not guarantee that a deposited connection can be withdrawn, as the cache manger is free to drop connections at any time.

このメソッドは、以前に追加された接続を取得しようとします。 指定された $type/$key を持つキャッシュされた接続が見つからない場合は、 undef が返されます。 キャッシュマネージャはいつでも自由に接続を破棄できるため、 追加された接続が取得できる保証はありません。

次のメソッドは内部で呼び出されます。 サブクラスはこれらのメソッドをオーバーライドする必要があるかもしれません。

$conn->enforce_limits([$type])

This method is called with after a new connection is added (deposited) in the cache or capacity limits are adjusted. The default implementation drops connections until the specified capacity limits are not exceeded.

このメソッドは、新しい接続がキャッシュに追加(配置)された後、 または容量制限が調整された後に呼び出されます。 デフォルトの実装では、指定された容量制限を超えなくなるまで、 接続が破棄されます。

$conn->dropping($conn_record, $reason)

This method is called when a connection is dropped. The record belonging to the dropped connection is passed as the first argument and a string describing the reason for the drop is passed as the second argument. The default implementation makes some noise if the $LWP::ConnCache::DEBUG variable is set and nothing more.

このメソッドは、接続が破棄されたときに呼び出されます。 破棄された接続に属するレコードが最初の引数として渡され、 破棄の理由を説明する文字列が 2 番目の引数として渡されます。 デフォルトの実装では、$LWP::ConnCache::DEBUG 変数が設定されている場合に ノイズが発生します。 それ以上のものはありません。

SUBCLASSING¶

特殊なキャッシュポリシーでは、LWP::ConnCache をサブクラス化し、 おそらく deposit(), enforce_limits(), dropping() メソッドを オーバーライドすることは理にかなっています。

オブジェクト自体はハッシュです。 cc_ で始まるキーは基底クラス用に予約されています。

SEE ALSO¶

LWP::UserAgent

コピーライト¶

Copyright 2001 Gisle Aas.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.