InstrumentProfileConnection (dxFeed API 3.319)

java.lang.Object
- com.dxfeed.ipf.live.InstrumentProfileConnection

```
public class InstrumentProfileConnection
extends Object
```
Connects to an instrument profile URL and reads instrument profiles with support of streaming live updates. Please see Instrument Profile Format documentation for complete description.
The key different between this class and InstrumentProfileReader is that the later just reads a snapshot of a set of instrument profiles, while this classes allows to track live updates, e.g. addition and removal of instruments.
To use this class you need an address of the data source from you data provider. The name of the IPF file can also serve as an address for debugging purposes.
The recommended usage of this class to receive a live stream of instrument profile updates is:
```
     String address = "<host>:<port>";
     InstrumentProfileCollector collector = new InstrumentProfileCollector();
     InstrumentProfileConnection connection = InstrumentProfileConnection.createConnection(address, collector);
     connection.start();
     collector.addUpdateListener(new InstrumentProfileUpdateListener() {
         public void instrumentProfilesUpdated(Iterator<InstrumentProfile> instruments) {
             while (instruments.hasNext()) {
                 InstrumentProfile instrument = instruments.next();
                 // do something with instrument here.
             }
         }
     });
 
```
If long-running processing of instrument profile is needed, then it is better to use instrumentProfilesUpdated notification to schedule processing task in a separate thread.
This class is thread-safe.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InstrumentProfileConnection.State
Instrument profile connection state.

Nested Classes
Modifier and Type	Class and Description
`static class`	`InstrumentProfileConnection.State` Instrument profile connection state.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStateChangeListener(PropertyChangeListener listener)` Adds listener that is notified about changes in `state` property.
`void`	`close()` Closes this instrument profile connection.
`static InstrumentProfileConnection`	`createConnection(String address, InstrumentProfileCollector collector)` Creates instrument profile connection with a specified address and collector.
`String`	`getAddress()` Returns the address of this instrument profile connection.
`long`	`getLastModified()` Returns last modification time (in milliseconds) of instrument profiles or zero if it is unknown.
`InstrumentProfileConnection.State`	`getState()` Returns state of this instrument profile connections.
`long`	`getUpdatePeriod()` Returns update period in milliseconds.
`void`	`removeStateChangeListener(PropertyChangeListener listener)` Removes listener that is notified about changes in `state` property.
`void`	`setUpdatePeriod(long updatePeriod)` Changes update period in milliseconds.
`void`	`start()` Starts this instrument profile connection.
`String`	`toString()` Returns a string representation of the object.
`boolean`	`waitUntilCompleted(long timeout, TimeUnit unit)` Synchronously waits for full first snapshot read with the specified timeout.

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

- Method Detail
  - createConnection
```
public static InstrumentProfileConnection createConnection(String address,
                                                           InstrumentProfileCollector collector)
```
    Creates instrument profile connection with a specified address and collector. Address may be just "<host>:<port>" of server, URL, or a file path. The "[update=<period>]" clause can be optionally added at the end of the address to specify an update period via an address string. Default update period is 1 minute.
    Connection needs to be started to begin an actual operation.
    
    Parameters:
    
    address - address.
    
    collector - instrument profile collector to push updates into.
    
    Returns:
    
    new instrument profile connection.
  - getAddress
```
public String getAddress()
```
    Returns the address of this instrument profile connection. It does not include additional options specified as part of the address.
    
    Returns:
    
    the address of this instrument profile connection.
  - getUpdatePeriod
```
public long getUpdatePeriod()
```
    Returns update period in milliseconds. It is period of an update check when the instrument profiles source does not support live updates and/or when connection is dropped. Default update period is 1 minute, unless overriden in an address string.
    
    Returns:
    
    update period in milliseconds.
  - setUpdatePeriod
```
public void setUpdatePeriod(long updatePeriod)
```
    Changes update period in milliseconds.
    
    Parameters:
    
    updatePeriod - update period in milliseconds.
    
    See Also:
    
    getUpdatePeriod()
  - getState
```
public InstrumentProfileConnection.State getState()
```
    Returns state of this instrument profile connections.
    
    Returns:
    
    state of this instrument profile connections.
  - getLastModified
```
public long getLastModified()
```
    Returns last modification time (in milliseconds) of instrument profiles or zero if it is unknown. Note, that while the time is represented in milliseconds, the actual granularity of time here is a second.
    
    Returns:
    
    last modification time (in milliseconds) of instrument profiles or zero if it is unknown.
  - start
```
public void start()
```
    Starts this instrument profile connection. This connection's state immediately changes to CONNECTING and the actual connection establishment proceeds in the background.
  - close
```
public void close()
```
    Closes this instrument profile connection. This connection's state immediately changes to CLOSED and the background update procedures are terminated.
  - addStateChangeListener
```
public void addStateChangeListener(PropertyChangeListener listener)
```
    Adds listener that is notified about changes in state property. Installed listener can be removed with removeStateChangeListener method.
    
    Parameters:
    
    listener - the listener to add.
  - removeStateChangeListener
```
public void removeStateChangeListener(PropertyChangeListener listener)
```
    Removes listener that is notified about changes in state property. It removes the listener that was previously installed with addStateChangeListener method.
    
    Parameters:
    
    listener - the listener to remove.
  - waitUntilCompleted
```
public boolean waitUntilCompleted(long timeout,
                                  TimeUnit unit)
```
    Synchronously waits for full first snapshot read with the specified timeout.
    
    Parameters:
    
    timeout - the maximum time to wait
    
    unit - the time unit of the timeout argument
    
    Returns:
    
    true if COMPLETED state was reached and false if the waiting time elapsed before snapshot was fully read.
  - toString
```
public String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class InstrumentProfileConnection

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createConnection

getAddress

getUpdatePeriod

setUpdatePeriod

getState

getLastModified

start

close

addStateChangeListener

removeStateChangeListener

waitUntilCompleted

toString