Public Member Functions | Private Attributes
org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint > Class Reference

List of all members.

Public Member Functions

XmlRpcClient getClient ()
boolean isObjectMethodLocal ()
Object newInstance (ClassLoader pClassLoader, final Class< T > pClass, final String pRemoteName, final int timeout)
void setObjectMethodLocal (boolean pObjectMethodLocal)
 XmlRpcClientFactory (XmlRpcClient pClient, TypeConverterFactory pTypeConverterFactory)
 XmlRpcClientFactory (XmlRpcClient pClient)

Private Attributes

final XmlRpcClient client
boolean objectMethodLocal
final TypeConverterFactory typeConverterFactory

Detailed Description

Modified version of org.apache.xmlrpc.client.util.ClientFactory that requires timeouts in calls.

Parameters:
<T>the type of XmlRpcEndpoint to create clients for
Author:
kwc@willowgarage.com (Ken Conley)
damonkohler@google.com (Damon Kohler)

Definition at line 42 of file XmlRpcClientFactory.java.


Constructor & Destructor Documentation

org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.XmlRpcClientFactory ( XmlRpcClient  pClient,
TypeConverterFactory  pTypeConverterFactory 
) [inline]

Creates a new instance.

Parameters:
pClientA fully configured XML-RPC client, which is used internally to perform XML-RPC calls.
pTypeConverterFactoryCreates instances of TypeConverterFactory, which are used to transform the result object in its target representation.

Definition at line 59 of file XmlRpcClientFactory.java.

org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.XmlRpcClientFactory ( XmlRpcClient  pClient) [inline]

Creates a new instance. Shortcut for

 new ClientFactory(pClient, new TypeConverterFactoryImpl());
 
Parameters:
pClientA fully configured XML-RPC client, which is used internally to perform XML-RPC calls.
See also:
TypeConverterFactoryImpl

Definition at line 76 of file XmlRpcClientFactory.java.


Member Function Documentation

XmlRpcClient org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.getClient ( ) [inline]

Returns the factories client.

Definition at line 83 of file XmlRpcClientFactory.java.

boolean org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.isObjectMethodLocal ( ) [inline]

Returns, whether a method declared by the Object class is performed by the local object, rather than by the server. Defaults to true.

Definition at line 91 of file XmlRpcClientFactory.java.

Object org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.newInstance ( ClassLoader  pClassLoader,
final Class< T >  pClass,
final String  pRemoteName,
final int  timeout 
) [inline]

Creates an object, which is implementing the given interface. The objects methods are internally calling an XML-RPC server by using the factories client.

Parameters:
pClassLoaderThe class loader, which is being used for loading classes, if required.
pClassInterface, which is being implemented.
pRemoteNameHandler name, which is being used when calling the server. This is used for composing the method name. For example, if pRemoteName is "Foo" and you want to invoke the method "bar" in the handler, then the full method name would be "Foo.bar".

Definition at line 120 of file XmlRpcClientFactory.java.

void org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.setObjectMethodLocal ( boolean  pObjectMethodLocal) [inline]

Sets, whether a method declared by the Object class is performed by the local object, rather than by the server. Defaults to true.

Definition at line 99 of file XmlRpcClientFactory.java.


Member Data Documentation

final XmlRpcClient org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.client [private]

Definition at line 44 of file XmlRpcClientFactory.java.

boolean org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.objectMethodLocal [private]

Definition at line 47 of file XmlRpcClientFactory.java.

final TypeConverterFactory org.ros.internal.node.xmlrpc.XmlRpcClientFactory< T extends org.ros.internal.node.xmlrpc.XmlRpcEndpoint >.typeConverterFactory [private]

Definition at line 45 of file XmlRpcClientFactory.java.


The documentation for this class was generated from the following file:


rosjava_core
Author(s):
autogenerated on Wed Aug 26 2015 16:06:51