org.vishia.communication

Class Address_InterProcessComm_Socket

java.lang.Object

org.vishia.communication.Address_InterProcessComm_Socket

All Implemented Interfaces:

Address_InterProcessComm

public class Address_InterProcessComm_Socket
extends java.lang.Object
implements Address_InterProcessComm

Implementation of Adress_InterProcessComm represents a java.net.socketAddr for socket communication. In C: This class is defined forward in the headerfile, the implementation is only visible here.

Field Summary

Fields

Modifier and Type	Field and Description
private java.net.InetSocketAddress	socketAddr
private java.lang.String	type UDP, TCP
static int	version Version, history and license.

Constructor Summary

Constructors

Constructor and Description
Address_InterProcessComm_Socket() Empty constructor to call setLocalHostPort later
Address_InterProcessComm_Socket(java.lang.String addr) Constructor with address given as String.
Address_InterProcessComm_Socket(java.lang.String type, int addr, int port) Constructor with full destination address given as 32-bit-integer value.
Address_InterProcessComm_Socket(java.lang.String type, java.lang.String addr, int port) Constructor with type, address and port.

Method Summary

Modifier and Type	Method and Description
(package private) java.net.InetSocketAddress	getSocketAddress() gets the pointer to the socket address.
void	setLocalHostPort(int port) Creates an destination adress at local host
void	setReceiveSocket(int port) Sets an receive socket on any local IP-Address.
(package private) void	storeSender(java.net.SocketAddress sender) store the socket Address into, only usefully if it is a SenderAddressInterProcessComm.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

version

public static final int version

Version, history and license.

• 2013-12-05 Hartmut chg: toString() does not returns the hostName, this needs communication and a DNS. Instead it returns the address (ip-number)
• 2005-01-01 Hartmut created.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

socketAddr

private java.net.InetSocketAddress socketAddr

type

private final java.lang.String type

UDP, TCP

Constructor Detail

Address_InterProcessComm_Socket

public Address_InterProcessComm_Socket()

Empty constructor to call setLocalHostPort later

Address_InterProcessComm_Socket

public Address_InterProcessComm_Socket(java.lang.String type,
                                       int addr,
                                       int port)

Constructor with full destination address given as 32-bit-integer value.

Parameters:

addr - The inet destination adress, Hi bytes are left, example 192.168.10.1 is 0xc0a80a01

port - The port of destination.

Address_InterProcessComm_Socket

public Address_InterProcessComm_Socket(java.lang.String addr)

Constructor with address given as String.

Parameters:

addr - The address inclusively type given in string format with port. Example "UDP:192.168.10.1:1234" The type and the port is separated by ':'.

Address_InterProcessComm_Socket

public Address_InterProcessComm_Socket(java.lang.String type,
                                       java.lang.String addr,
                                       int port)

Constructor with type, address and port.

Parameters:

type - The type should be "UDP", "TCP" or it may be null. If the type is null, the type is gotten from the addr-parameter as string-part before a ':'.

addr - The address. If type and port are given, it is a String which is compatible to java.net.InetSocketAddress. Usual it is a String with 4 octets with numbers like "192.168.1.1". If the type is not given, the type is contained in this parameter before a ':'. If the port is not given the port is the integer number after a trailing ':'.

port - A positive value for the Port number or -1 if the port is contained in addr.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setLocalHostPort

public void setLocalHostPort(int port)

Creates an destination adress at local host

Parameters:

port - the portnumber at localhost

setReceiveSocket

public void setReceiveSocket(int port)

Sets an receive socket on any local IP-Address. Note: It uses the IP-wildcard address internally. It is 0.0.0.0 usually. Drivers listen at any IP-Hardware inclusive the local-host-software-interface.

getSocketAddress

java.net.InetSocketAddress getSocketAddress()

gets the pointer to the socket address. This methods are only usefully for the implementation of the InterProcessComm, therefore package-private.

storeSender

void storeSender(java.net.SocketAddress sender)

store the socket Address into, only usefully if it is a SenderAddressInterProcessComm. It is used only package-private for Implementation of the InterProcessComm_SocketImpl

Parameters:

sender - The sender address.