As we saw in Section 10.11, for each operation on an interface, the proxy class contains a corresponding member function with the same name. To invoke an operation, you call it via the proxy. For example, here is part of the definitions for our file system from
Section 5.4:
module Filesystem {
interface Node {
idempotent string name();
};
// ...
};
The name operation returns a value of type
string. Given a proxy to an object of type
Node, the client can invoke the operation as follows:
NodePrx node = ...; // Initialize proxy
String name = node.name(); // Get name via RPC
This illustrates the typical pattern for receiving return values: return values are returned by reference for complex types, and by value for simple types (such as
int or
double).
10.12.1 Normal and idempotent Operations
You can add an idempotent qualifier to a Slice operation. As far as the signature for the corresponding proxy method is concerned,
idempotent has no effect. For example, consider the following interface:
interface Example {
string op1();
idempotent string op2();
};
public interface ExamplePrx extends Ice.ObjectPrx {
public String op1();
public String op2();
}
Because idempotent affects an aspect of call dispatch, not interface, it makes sense for the two methods to be mapped the same.
The parameter passing rules for the Java mapping are very simple: parameters are passed either by value (for simple types) or by reference (for complex types and type
String). Semantically, the two ways of passing parameters are identical: it is guaranteed that the value of a parameter will not be changed by the invocation (with some caveats—see
page 879).
struct NumberAndString {
int x;
string str;
};
sequence<string> StringSeq;
dictionary<long, StringSeq> StringTable;
interface ClientToServer {
void op1(int i, float f, bool b, string s);
void op2(NumberAndString ns, StringSeq ss, StringTable st);
void op3(ClientToServer* proxy);
};
public interface ClientToServerPrx extends Ice.ObjectPrx {
public void op1(int i, float f, boolean b, String s);
public void op2(NumberAndString ns,
String[] ss,
java.util.Map st);
public void op3(ClientToServerPrx proxy);
}
Given a proxy to a ClientToServer interface, the client code can pass parameters as in the following example:
ClientToServerPrx p = ...; // Get proxy...
p.op1(42, 3.14f, true, "Hello world!"); // Pass simple literals
int i = 42;
float f = 3.14f;
boolean b = true;
String s = "Hello world!";
p.op1(i, f, b, s); // Pass simple variables
NumberAndString ns = new NumberAndString();
ns.x = 42;
ns.str = "The Answer";
String[] ss = { "Hello world!" };
java.util.HashMap st = new java.util.HashMap();
st.put(new Long(0), ns);
p.op2(ns, ss, st); // Pass complex variables
p.op3(p); // Pass proxy
Java does not have pass-by-reference: parameters are always passed by value. For a function to modify one of its arguments, we must pass a reference (by value) to an object; the called function can then modify the object’s contents via the passed reference.
To permit the called function to modify a parameter, the Java mapping uses so-called
holder classes. For example, for each of the built‑in Slice types, such as
int and
string, the
Ice package contains a corresponding holder class. Here are the definitions for the holder classes
Ice.IntHolder and
Ice.StringHolder:
package Ice;
public final class IntHolder {
public IntHolder() {}
public IntHolder(int value)
this.value = value;
}
public int value;
}
public final class StringHolder {
public StringHolder() {}
public StringHolder(String value) {
this.value = value;
}
public String value;
}
A holder class has a public value member that stores the value of the parameter; the called function can modify the value by assigning to that member. The class also has a default constructor and a constructor that accepts an initial value.
For user-defined types, such as structures, the Slice-to-Java compiler generates a corresponding holder type. For example, here is the generated holder type for the
NumberAndString structure we defined on
page 333:
public final class NumberAndStringHolder {
public NumberAndStringHolder() {}
public NumberAndStringHolder(NumberAndString value) {
this.value = value;
}
public NumberAndString value;
}
This looks exactly like the holder classes for the built‑in types: we get a default constructor, a constructor that accepts an initial value, and the public
value member.
Note that holder classes are generated for every Slice type you define. For example, for sequences, such as the
FruitPlatter sequence we saw on
page 318, the compiler does not generate a special Java
FruitPlatter type because sequences map to Java arrays. However, the compiler
does generate a
FruitPlatterHolder class, so we can pass a
FruitPlatter array as an out-parameter.
To pass an out-parameter to an operation, we simply pass an instance of a holder class and examine the
value member of each out-parameter when the call completes. Here is the same Slice definition we saw on
page 333 once more, but this time with all parameters being passed in the
out direction:
struct NumberAndString {
int x;
string str;
};
sequence<string> StringSeq;
dictionary<long, StringSeq> StringTable;
interface ServerToClient {
void op1(out int i, out float f, out bool b, out string s);
void op2(out NumberAndString ns,
out StringSeq ss,
out StringTable st);
void op3(out ServerToClient* proxy);
};
public interface ClientToServerPrx extends Ice.ObjectPrx {
public void op1(Ice.IntHolder i, Ice.FloatHolder f,
Ice.BooleanHolder b, Ice.StringHolder s);
public void op2(NumberAndStringHolder ns,
StringSeqHolder ss, StringTableHolder st);
public void op3(ClientToServerPrxHolder proxy);
}
Given a proxy to a ServerToClient interface, the client code can pass parameters as in the following example:
ClientToServerPrx p = ...; // Get proxy...
Ice.IntHolder ih = new Ice.IntHolder();
Ice.FloatHolder fh = new Ice.FloatHolder();
Ice.BooleanHolder bh = new Ice.BooleanHolder();
Ice.StringHolder sh = new Ice.StringHolder();
p.op1(ih, fh, bh, sh);
NumberAndStringHolder nsh = new NumberAndString();
StringSeqHolder ssh = new StringSeqHolder();
StringTableHolder sth = new StringTableHolder();
p.op2(nsh, ssh, sth);
ServerToClientPrxHolder stcph = new ServerToClientPrxHolder();
p.op3(stch);
System.out.writeln(ih.value); // Show one of the values
Again, there are no surprises in this code: the various holder instances contain values once the operation invocation completes and the
value member of each instance provides access to those values.
Some Slice types naturally have "empty" or "not there" semantics. Specifically, sequences, dictionaries, and strings all can be
null, but the corresponding Slice types do not have the concept of a null value. To make life with these types easier, whenever you pass
null as a parameter or return value of type sequence, dictionary, or string, the Ice run time automatically sends an empty sequence, dictionary, or string to the receiver.
This behavior is useful as a convenience feature: especially for deeply-nested data types, members that are sequences, dictionaries, or strings automatically arrive as an empty value at the receiving end. This saves you having to explicitly initialize, for example, every string element in a large sequence before sending the sequence in order to avoid
NullPointerExceptions. Note that using null parameters in this way does
not create null semantics for Slice sequences, dictionaries, or strings. As far as the object model is concerned, these do not exist (only
empty sequences, dictionaries, and strings do). For example, whether you send a string as
null or as an empty string makes no difference to the receiver: either way, the receiver sees an empty string.
