InterProcessCommFactory

java.lang.Object
- org.vishia.communication.InterProcessCommFactory

Direct Known Subclasses:

InterProcessCommFactoryAccessor, InterProcessCommFactorySocket
```
public abstract class InterProcessCommFactory
extends java.lang.Object
```
This class is used as interface and as singleton instance access for factory of any InterProcessComm. An derived instance of this class which offers all necessary types of InterProcessComm should be created on start of an application. See InterProcessCommFactorySocket. For example:
```
   new InterProcessCommFactorySocket();  //creates a singleton.
 
```
This instance can be used with the following pattern:
```
   InterProcessCommFactory.singeton().create("UDP:127.0.0.1:60100");
 
```
This example creates an InterProcessComm instance which uses an Socket-UDP-Protocoll on port 60100 on local host (loop back).

A further instance can be created, for example for test reasons. Then an association need to be set:
```
   InterProcessCommFactory ipcFactory = new InterProcessCommFactorySocket();  //creates a singleton.
   .....
   ipcFactory.create("UDP:127.0.0.1:60105");
 
```

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String sVersion
Version, history and license.

private static InterProcessCommFactory theSingleton

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`sVersion` Version, history and license.
`private static InterProcessCommFactory`	`theSingleton`

Constructor Summary

Constructors
Modifier Constructor and Description

protected InterProcessCommFactory()
Sets theSingleton if not set yet. returns always a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`InterProcessCommFactory()` Sets `theSingleton` if not set yet. returns always a new instance.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract InterProcessComm`	`create(Address_InterProcessComm addr)` Creates an instance of the InterProcessComm for the given communication implementation.
`abstract InterProcessComm`	`create(java.lang.String protocolAndOwnAddr)` Creates an instance of the InterProcessComm for the given communication implementation.
`abstract InterProcessComm`	`create(java.lang.String protocolAndOwnAddr, int nPort)` Creates a InterProcessComm from a parameter String.
`abstract Address_InterProcessComm`	`createAddress(java.lang.String protocolAndOwnAddr)` Creates an address for a specific communication channel.
`abstract Address_InterProcessComm`	`createAddress(java.lang.String protocolAndOwnAddr, int nPort)` Creates an address for a specific communication channel.
`static InterProcessCommFactory`	`getInstance()` Gets the instance of the `InterProcessCommFactory` for this application.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - sVersion
```
public static final java.lang.String sVersion
```
    Version, history and license. This String is visible in the about info.
    - 2015-08-16 JcHartmut: Define as abstract class instead interface without necessity of changing an application, join with InterProcessCommFactoryAccessor, no need of 2 classes.
    - 2016-2011 some changes, see source files.
    - 2006-00-00 JcHartmut 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 doesn'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 intent to use this source without publishing its usage, you can get a second license subscribing a special contract with the author.
    See Also:
    
    Constant Field Values
  - theSingleton
```
private static InterProcessCommFactory theSingleton
```
- Constructor Detail
  - InterProcessCommFactory
```
protected InterProcessCommFactory()
```
    Sets theSingleton if not set yet. returns always a new instance.
- Method Detail
  - getInstance
```
public static InterProcessCommFactory getInstance()
```
    Gets the instance of the InterProcessCommFactory for this application.
    
    Returns:
    
    null if nothing was intialized. Note that an derived class of this need to be create on start of the application.
  - createAddress
```
public abstract Address_InterProcessComm createAddress(java.lang.String protocolAndOwnAddr,
                                                       int nPort)
```
    Creates an address for a specific communication channel. It can be used for create(Address_InterProcessComm).
    
    Parameters:
    
    protocolAndOwnAddr - String determines the channel. For example "UDP:0.0.0.0" to create a socket communication.
    
    nPort - Numeric value for the fine definition. Port number for Socket.
    
    Returns:
    
    The address or null if not successfully.
  - createAddress
```
public abstract Address_InterProcessComm createAddress(java.lang.String protocolAndOwnAddr)
```
    Creates an address for a specific communication channel. It can be used for create(Address_InterProcessComm).
    
    Parameters:
    
    protocolAndOwnAddr - String determines the channel. For example "UDP:0.0.0.0:6000" to create a socket communication.
    
    Returns:
    
    The address or null if not successfully.
  - create
```
public abstract InterProcessComm create(java.lang.String protocolAndOwnAddr,
                                        int nPort)
```
    Creates a InterProcessComm from a parameter String. The type depends on this String. For example:
    - "UDP:192.16.35.3" for UDP via socket. Don't write spaces, set the port after ':'
    Parameters:
    
    protocolAndOwnAddr - A string which determines the kind of communication and the own address (slot). It depends on the underlying system which kind of communication are supported
    
    Returns:
    
    null or an instance maybe with opened communication.
  - create
```
public abstract InterProcessComm create(java.lang.String protocolAndOwnAddr)
```
    Creates an instance of the InterProcessComm for the given communication implementation.
    
    Parameters:
    
    protocolAndOwnAddr - It determines the communication channel. Use "UDP:0.0.0.0:6000" for example to create an UDP-Socket communication which uses the port 6000 on all existing network adapters.
    
    Returns:
  - create
```
public abstract InterProcessComm create(Address_InterProcessComm addr)
```
    Creates an instance of the InterProcessComm for the given communication implementation.
    
    Parameters:
    
    addr - The own address, see createAddress(String) and createAddress(String, int).
    
    Returns:
    
    the instance, null if not sucessfully.

Class InterProcessCommFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

sVersion

theSingleton

Constructor Detail

InterProcessCommFactory

Method Detail

getInstance

createAddress

createAddress

create

create

create