All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class Ice.Channel 

java.lang.Object
   |
   +----Ice.Channel
public final class Channel
extends Object
The Channel Class

A Channel is a communication object of the ICE-Communication. Every program (thread) which wants to communicate with other components has to have at least one Component-Object (describing itsself to ICE) and a base channel (to describe the component which it wants to communicate with).

This class does not contain a public Constructor for a base channel and has to be instantiated by the AddCompo-method of its Component. An additional channel could be added by the AddChan-method of an instantiated Channel.

Version:
1.0, 17 Nov 1997
Author:
Volker Weber

Method Index

o AddChan(String, int)
Add a new additional channel with name and based on channel base (AddChan(...)).
o Broadcast(boolean)
Broadcast a boolean-Primitive message (Shortcut-Broadcast).
o Broadcast(char)
Broadcast a char-Primitive message (Shortcut-Broadcast).
o Broadcast(double)
Broadcast a boolean-Primitive message (Shortcut-Broadcast).
o Broadcast(int, long, String, int, int, int, boolean)
Broadcast a boolean-Primitive message.
o Broadcast(int, long, String, int, int, int, char)
Broadcast a char-Primitive message.
o Broadcast(int, long, String, int, int, int, double)
Broadcast a boolean-Primitive message.
o Broadcast(int, long, String, int, int, int, long)
Broadcast a byte/short/int/long-Primitive message.
o Broadcast(int, long, String, int, int, int, Object)
Broadcast an Object message.
o Broadcast(long)
Broadcast a byte/short/int/long-Primitive message (Shortcut-Broadcast).
o Broadcast(Object)
Broadcast an Object message (Shortcut-Broadcast).
o finalize()
Destructor for a Channel Deprecated.
o Name()
Give the name of the channel.
o Probe(int)
Probe if we could receive a Message (Probe(...)).
o Receive(int)
Receive a Message (without timeout)
o Receive(int, long)
Receive a Message with timeout (Receive(...) and TReceive(...)).
o Remove()
Request a channel deletion (RemoveCompo(...) and RemoveChan(...)).
o Send(boolean)
Send a boolean-Primitive message (Shortcut-Send).
o Send(char)
Send a char-Primitive message (Shortcut-Send)
o Send(double)
Send a float/double-Primitive message (Shortcut-Send)
o Send(int, long, String, int, int, int, boolean)
Send a boolean-Primitive message.
o Send(int, long, String, int, int, int, char)
Send a char-Primitive message
o Send(int, long, String, int, int, int, double)
Send a float/double-Primitive message
o Send(int, long, String, int, int, int, long)
Send a byte/short/int/long-Primitive message
o Send(int, long, String, int, int, int, Object)
Send an Object message (Send(...)).
o Send(long)
Send a byte/short/int/long-Primitive message (Shortcut-Send)
o Send(Object)
Send an Object message (Shortcut-Send)

Methods

o AddChan 
 public Channel AddChan(String name,
                        int flags)
Add a new additional channel with name and based on channel base (AddChan(...)).

Parameters:
name - name of an additional channel for communication
flags - flags for the new channel
Returns:
Channel object for an additional channel
See Also:
ANYCHAN, BASE, NORMAL, SYNCH, RAW, TOKEN
o finalize 
 public void finalize()
Note: finalize() is deprecated.

Destructor for a Channel

Overrides:
finalize in class Object
See Also:
Remove
o Remove 
 public void Remove()
Request a channel deletion (RemoveCompo(...) and RemoveChan(...)). This method need not to be called, since Channel-Objects are removed by Java's Garbage collector when they are not longer referenced. If you detach a component all dependend channels are finalized also.

See Also:
Detach
o Send 
 public boolean Send(char mData)
Send a char-Primitive message (Shortcut-Send)

Parameters:
mData - a char-primitive to be send
See Also:
Send
o Send 
 public boolean Send(int msgtag,
                     long turn,
                     String concern,
                     int t_Start,
                     int t_End,
                     int prio,
                     char mData)
Send a char-Primitive message

Parameters:
mData - a char-primitive to be send
See Also:
Send
o Send 
 public boolean Send(long mData)
Send a byte/short/int/long-Primitive message (Shortcut-Send)

Parameters:
mData - a byte/short/int/long-primitive to be send
See Also:
Send
o Send 
 public boolean Send(int msgtag,
                     long turn,
                     String concern,
                     int t_Start,
                     int t_End,
                     int prio,
                     long mData)
Send a byte/short/int/long-Primitive message

Parameters:
mData - a byte/short/int/long-primitive to be send
See Also:
Send
o Send 
 public boolean Send(double mData)
Send a float/double-Primitive message (Shortcut-Send)

Parameters:
mData - a float/double-primitive to be send
See Also:
Send
o Send 
 public boolean Send(int msgtag,
                     long turn,
                     String concern,
                     int t_Start,
                     int t_End,
                     int prio,
                     double mData)
Send a float/double-Primitive message

Parameters:
mData - a float/double-primitive to be send
See Also:
Send
o Send 
 public boolean Send(boolean mData)
Send a boolean-Primitive message (Shortcut-Send). Since ICE/IDL has no special boolean type this is send as Long. true = 1L; false = 0L

Parameters:
mData - a boolean-primitive to be send
See Also:
Send
o Send 
 public boolean Send(int msgtag,
                     long turn,
                     String concern,
                     int t_Start,
                     int t_End,
                     int prio,
                     boolean mData)
Send a boolean-Primitive message. Since ICE/IDL has no special boolean type this is send as Long. true = 1L; false = 0L

Parameters:
mData - a boolean-primitive to be send
See Also:
Send
o Send 
 public boolean Send(Object mData)
Send an Object message (Shortcut-Send)

Parameters:
mData - an arbitrary Java-Object
See Also:
Send
o Send 
 public boolean Send(int msgtag,
                     long turn,
                     String concern,
                     int t_Start,
                     int t_End,
                     int prio,
                     Object mData)
Send an Object message (Send(...)).

Parameters:
msgtag - a message tag for this message
turn - an unsigned turn-Id for this message
concern - a concern for this message
t_Start - a start index for this message
t_End - an end index for this message
prio - priority or rating for this message
mData - an arbitrary Java-Object
Returns:
true, iff sending was successfull; false otherwise
See Also:
NONE, NOTAG, CMPTAG
o Receive 
 public Msg Receive(int msgtag)
Receive a Message (without timeout)

See Also:
Receive
o Receive 
 public Msg Receive(int msgtag,
                    long timeout)
Receive a Message with timeout (Receive(...) and TReceive(...)).

Parameters:
msgtag - a message tag for the received message
timeout - a timeout for receiving messages in milliseconds (iff the timeout is negative, no timeout is used).
Returns:
the received Ice.Msg, or null on failure
See Also:
NONE, ANY, NOTAG, CMPTAG
o Probe 
 public boolean Probe(int msgtag)
Probe if we could receive a Message (Probe(...)).

Parameters:
msgtag - a message tag for receiving a message
Returns:
true, iff we could receive a message
See Also:
NONE, ANY, NOTAG, CMPTAG
o Broadcast 
 public boolean Broadcast(char mData)
Broadcast a char-Primitive message (Shortcut-Broadcast). Broadcast is a Send to all components.

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(int msgtag,
                          long turn,
                          String concern,
                          int t_Start,
                          int t_End,
                          int prio,
                          char mData)
Broadcast a char-Primitive message. Broadcast is a Send to all components.

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(long mData)
Broadcast a byte/short/int/long-Primitive message (Shortcut-Broadcast). Broadcast is a Send to all components.

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(int msgtag,
                          long turn,
                          String concern,
                          int t_Start,
                          int t_End,
                          int prio,
                          long mData)
Broadcast a byte/short/int/long-Primitive message. Broadcast is a Send to all components.

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(double mData)
Broadcast a boolean-Primitive message (Shortcut-Broadcast). Broadcast is a Send to all components. Since ICE/IDL has no special boolean type this is send as Long. true = 1L; false = 0L

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(int msgtag,
                          long turn,
                          String concern,
                          int t_Start,
                          int t_End,
                          int prio,
                          double mData)
Broadcast a boolean-Primitive message. Broadcast is a Send to all components. Since ICE/IDL has no special boolean type this is send as Long. true = 1L; false = 0L

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(boolean mData)
Broadcast a boolean-Primitive message (Shortcut-Broadcast). Broadcast is a Send to all components. Since ICE/IDL has no special boolean type this is send as Long. true = 1L; false = 0L

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(int msgtag,
                          long turn,
                          String concern,
                          int t_Start,
                          int t_End,
                          int prio,
                          boolean mData)
Broadcast a boolean-Primitive message. Broadcast is a Send to all components. Since ICE/IDL has no special boolean type this is send as Long. true = 1L; false = 0L

Parameters:
mData - a boolean-primitive to be send
See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(Object mData)
Broadcast an Object message (Shortcut-Broadcast). Broadcast is a Send to all components.

See Also:
Send, Send
o Broadcast 
 public boolean Broadcast(int msgtag,
                          long turn,
                          String concern,
                          int t_Start,
                          int t_End,
                          int prio,
                          Object mData)
Broadcast an Object message. Broadcast is a Send to all components. (Broadcast(...)).

See Also:
Send
o Name 
 public String Name()
Give the name of the channel.

Returns:
Name of the channel 
All Packages  Class Hierarchy  This Package  Previous  Next  Index