Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

bpipe

Bloomberg B-PIPE connection V3

The bpipe function provides the connection to Bloomberg® B-PIPE®.

There are other functions that connect to different Bloomberg services: Bloomberg Desktop (blp), Bloomberg Server (blpsrv), and Bloomberg Data License (bdl). For details about these Bloomberg services, see Comparing Bloomberg Connections.

For details about Bloomberg connection requirements, see Data Server Connection Requirements. To ensure a successful Bloomberg connection, perform the required steps before executing bpipe. For details, see Installing Bloomberg and Configuring Connections.

Syntax

c = bpipe(authtype,appname,serverip,portnumber)
c = bpipe(authtype,appname,serverip,portnumber,timeout)

Description

example

c = bpipe(authtype,appname,serverip,portnumber) creates a Bloomberg B-PIPE connection c using the following:

  • Authorization type authtype

  • Application name appname

  • IP address serverip of the machine where the Bloomberg B-PIPE process is running

  • Port number

example

c = bpipe(authtype,appname,serverip,portnumber,timeout) creates a Bloomberg B-PIPE connection c using a timeout value.

Examples

collapse all

Create a Bloomberg B-PIPE connection using the IP address of the machine where the Bloomberg B-PIPE process is running. This code assumes the following:

  • The authentication is Windows® Authentication when setting authtype to 'OS_LOGON'.

  • The application name is blank because you are not connecting to Bloomberg B-PIPE using an application.

  • The IP address serverip for the machine, which is running the Bloomberg B-PIPE process, is '111.11.11.112'.

  • The port number is 8194.

authtype = 'OS_LOGON';
appname = '';
serverip = {'111.11.11.112'};
portnumber = 8194;

c = bpipe(authtype,appname,serverip,portnumber)
c = 

  bpipe with properties:

    appauthtype: ''
       authtype: 'OS_LOGON'
        appname: []
           user: [1x1 com.bloomberglp.blpapi.impl.aT]
        session: [1x1 com.bloomberglp.blpapi.Session]
      ipaddress: {'111.11.11.112'}
           port: 8194.00
        timeout: 0

bpipe connects to Bloomberg B-PIPE at port number 8194. bpipe creates the Bloomberg B-PIPE connection object c with these properties:

  • Application authentication type

  • Bloomberg user authentication type

  • Application name

  • Bloomberg user identity object

  • Bloomberg V3 API object

  • IP address of the machine where the Bloomberg B-PIPE process is running

  • Port number of the machine where the Bloomberg B-PIPE process is running

  • Number in milliseconds specifying how long MATLAB® attempts to connect to the machine running the Bloomberg V3 B-PIPE API before timing out

Close the Bloomberg B-PIPE connection.

close(c)

Create a Bloomberg B-PIPE connection using the IP address of the machine where the Bloomberg B-PIPE process is running. This code assumes the following:

  • The authentication is Windows Authentication when setting authtype to 'OS_LOGON'.

  • The application name is blank because you are not connecting to Bloomberg B-PIPE using an application.

  • The IP address serverip for the machine, which is running the Bloomberg B-PIPE process, is '111.11.11.112'.

  • The port number is 8194.

  • The timeout value is 1000 milliseconds.

authtype = 'OS_LOGON';
appname = '';
serverip = {'111.11.11.112'};
portnumber = 8194;
timeout = 1000;

c = bpipe(authtype,appname,serverip,portnumber,timeout)
c = 

  bpipe with properties:

    appauthtype: ''
       authtype: 'OS_LOGON'
        appname: []
           user: [1x1 com.bloomberglp.blpapi.impl.aT]
        session: [1x1 com.bloomberglp.blpapi.Session]
      ipaddress: {'172.28.17.118'}
           port: 8194.00
        timeout: 1000.00

bpipe connects to Bloomberg B-PIPE at port number 8194. bpipe creates the Bloomberg B-PIPE connection object c with these properties:

  • Application authentication type

  • Bloomberg user authentication type

  • Application name

  • Bloomberg user identity object

  • Bloomberg V3 API object

  • IP address of the machine where the Bloomberg B-PIPE process is running

  • Port number of the machine where the Bloomberg B-PIPE process is running

  • Number in milliseconds specifying how long MATLAB attempts to connect to the machine running the Bloomberg V3 B-PIPE API before timing out

Close the Bloomberg B-PIPE connection.

close(c)

Input Arguments

collapse all

Authorization type, specified as one of these Bloomberg values.

Bloomberg Value

Description

'OS_LOGON'

Create Bloomberg B-PIPE connection with Windows Authentication.

'APPLICATION_ONLY'

Create Bloomberg B-PIPE connection with application authentication.

For details, see the Bloomberg B-PIPE API Developer’s Guide using the WAPI <GO> option from the Bloomberg terminal.

Application name, specified as a character vector or string scalar to identify the application you are using that connects to Bloomberg B-PIPE.

Data Types: char | string

IP address for the machine, specified as a character vector, cell array of character vectors, string scalar, or string array. A character vector or string scalar identifies the machine where the Bloomberg B-PIPE process is running, whereas a cell array of character vectors or string array denotes multiple machines.

Data Types: char | cell | string

Port number, specified as a numeric scalar to identify the port number of the machine where the Bloomberg B-PIPE process is running.

Data Types: double

Timeout value that denotes the time in milliseconds the local machine attempts to connect before timing out, specified as a numeric scalar.

Data Types: double

Output Arguments

collapse all

Bloomberg B-PIPE connection, returned as a connection object with these properties.

Property

Description

appauthtype

Application authentication type

authtype

Bloomberg user authentication type

appname

Application name

user

Bloomberg user identity object

session

Bloomberg V3 API object

ipaddress

IP address of the machine where the Bloomberg B-PIPE process is running

port

Port number of the machine where the Bloomberg B-PIPE process is running

timeout

Number in milliseconds specifying how long MATLAB attempts to connect to the machine running the Bloomberg V3 B-PIPE API before timing out

Introduced in R2014b

Was this topic helpful?